Clarify RasterDataset documentation for is_image and dtype #1811
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
…o override dtype.
Revert DEMs to masks
github-actions
bot
added
documentation
adamjstewart
requested changes
Jan 17, 2024
|
You can also include the CSV changes if you want: "image -> DEM" |
|
Done. |
adamjstewart
approved these changes
Feb 29, 2024
isaaccorley
pushed a commit
that referenced
this pull request
Mar 2, 2024
* Change DEMs from mask to image (is_image=True) * fix to revert to upstream file * fix unused type: ignore comment * Update torchgeo/datasets/geo.py Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com> * Update documentation to explain is_image and dtype. Update asterdem to override dtype. * fix linting errors * Made comment for is_image more succint. * change asterdem dtype back to float32 (same as RasterDataset) * removed integer images from documentation * change Digital Elevation Model to DEM * Clarify is_image and dtype. Revert DEMs to masks * Finish reverting DEMs to masks * address review comments * Changed Aster Global DEM and EU-DEM Dataset types to "DEM" * Reorganize some information * Use better formatting --------- Co-authored-by: Adam J. Stewart <ajstewart426@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for the
is_imageanddtypeproperties ofRasterDatasetwere vague in regards to what to do for surface models, like DEMs. The changes proposed attempt to clarify how one should go about treating surface models for different circumstances when creating a custom RasterDataset.