ee_extra.Spectral.core.indices

ee_extra.Spectral.core.indices(online=False)

Gets the dictionary of available indices.

Parameters:

online (bool) – Whether to retrieve the most recent list of indices directly from the GitHub repository and not from the local copy.

Return type:

dict

Returns:

Dictionary of available indices.

Examples

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