common¶

Functions of the common module:

eemont.common.indices()[source]¶

Gets the dictionary of available indices as a Box object.

Returns: Dictionary of available indices. For each index, the keys ‘description’, ‘formula’, ‘requires’, ‘reference’ and ‘contributor’ can be checked.
Return type: Box

Examples

>>> import eemont
>>> indices = eemont.indices()
>>> indices.BAIS2.description
'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'

eemont.common.listIndices()[source]¶

Gets the list of available indices.

Returns: List of available indices.
Return type: list

Examples

>>> import eemont
>>> eemont.listIndices()
['BNDVI','CIG','CVI','EVI','EVI2','GBNDVI','GNDVI',...]