Multispectral Index#
- rforge.library.processes.index.index(index_id: str, parameters: dict, alpha: Layer | ndarray | None = None, thresholds: list | tuple | None = None, binarize: bool = False, as_array: bool = False) ndarray | Layer[source]#
Compute an index from the input parameters.
- Parameters:
index_id – Identifier of index to compute
parameters – Dictionary of parameters required for index computation.
alpha – Alpha layer. Defaults to None.
thresholds – Thresholds for binarization or clipping. Defaults to None.
binarize – If True, binarize the result based on the thresholds defined. Defaults to False.
as_array – If True, return the result as a Numpy array. Defaults to False.
- Returns:
Computed index as a numpy array.
- Raises:
TypeError – If inputs are not of the accepted type.