eemont.common.indices¶

eemont.common.indices(online=False)[source]¶

Gets the dictionary of available indices as a Box object.

Parameters: online (boolean) – Wheter to retrieve the most recent list of indices directly from the GitHub repository and not from the local copy.
Returns: Dictionary of available indices. For each index, the keys ‘short_name’, ‘long_name’, ‘formula’, ‘bands’, ‘reference’, ‘type’, ‘date_of_addition’ and ‘contributor’ can be checked.
Return type: Box

See also

listIndices: Gets the list of available indices.

Examples

>>> import eemont
>>> indices = eemont.indices()
>>> indices.BAIS2.long_name
'Burned Area Index for Sentinel 2'
>>> indices.BAIS2.formula
'(1.0 - ((RE2 * RE3 * RE4) / R) ** 0.5) * (((S2 - RE4)/(S2 + RE4) ** 0.5) + 1.0)'
>>> indices.BAIS2.reference
'https://doi.org/10.3390/ecrs-2-05177'