Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to spectral indices #387

Open
1 of 4 tasks
calebrob6 opened this issue Feb 2, 2022 · 2 comments
Open
1 of 4 tasks

Improvements to spectral indices #387

calebrob6 opened this issue Feb 2, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation transforms Data augmentation transforms

Comments

@calebrob6
Copy link
Member

calebrob6 commented Feb 2, 2022

There are a few improvements we can make to the spectral index transforms in torchgeo:

  • Adding a latex rendering of the index in the docs that show the wavelengths of the bands used (with their common names). E.g. the NDRE index uses the NIR and Red Edge bands:
    image
  • Adding the indices documented in IDB and awesome-spectral-indices
  • Documenting common use cases of each index from the associated papers
  • Documenting how to interpret index values (e.g. NDVI is between [-1, 1] where -1 is generally unhealthy/no vegetation and 1 is healthy vegetation)

(@MATRIX4284 -- tagging you for visibility as you've been working on the indices)

@adamjstewart adamjstewart added the documentation Improvements or additions to documentation label Feb 2, 2022
@adamjstewart
Copy link
Collaborator

For math rendering in Sphinx, there are many options: https://www.sphinx-doc.org/en/master/usage/extensions/math.html

PyTorch uses sphinxcontrib.katex, not sure if it has any advantages over the builtin extensions.

@adamjstewart adamjstewart added the transforms Data augmentation transforms label Feb 2, 2022
@MATRIX4284
Copy link
Contributor

  • IDB

i have started working on addingthe other indices.Will update soon

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation transforms Data augmentation transforms
Projects
None yet
Development

No branches or pull requests

3 participants