dataset/crop/feature/crop-all-within-polygon

[MAfarrag]

Crop cell that touches the mask not only lies inside.

• Introduce a new parameter touch to the crop method in the Dataset to enable considering the cells that most of the cell lies inside the mask, not only the cells that lie entirely inside the mask.

• Introduce a new parameter inplace to the crop method in the Dataset to enable replacing the dataset object with the new cropped dataset.

• Adjust the stats method to take a mask to calculate the stats inside this mask.

• Fixes # (issue)

• Statistics for cells within a given polygon/raster #68

• Crop any touched cells #66

• inplace parameter for the crop method #64

Type of change

Check relevant points.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

• Please describe the tests that you ran to verify your changes.

• Provide instructions so we can reproduce.

• Please also list any relevant details for your test configuration

• test_dataset::TestCropWithPolygon::test_inplace

• test_dataset::TestCropWithPolygon::test_by_warp_touch_true

• test_dataset::TestCropWithPolygon::test_by_warp_touch_false

• test_dataset::TestStats::test_all_bands_with_mask

Checklist:

• updated version number in setup.py/pyproject.toml.
• updated environment.yml and the lock file.
• added changes to History.rst.
• updated the latest version in README file.
• I have added tests that prove my fix is effective or that my feature works.
• New and existing unit tests pass locally with my changes.
• documentation are updated.

[codecov]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (4725d7b) 83.29% compared to head (6580d6a) 83.75%.

Files	Patch %	Lines
pyramids/dataset.py	93.10%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #71      +/-   ##
==========================================
+ Coverage   83.29%   83.75%   +0.46%     
==========================================
  Files           7        7              
  Lines        2119     2118       -1     
==========================================
+ Hits         1765     1774       +9     
+ Misses        354      344      -10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.