Calculators

NDVI

Source code in eegeolab/calculators.py

class NDVI:
    def __init__(self, nir: str, red: str, name: str = None) -> None:
        self.nir = nir
        self.red = red
        self.name = name

    @property
    def name(self):
        return self._name

    @name.setter
    def name(self, name: str):
        self._name = "NDVI" if name is None else name

    def __call__(self, image: ee.Image) -> Any:
        return image.addBands(self.compute(image=image))

    def compute(self, image: ee.Image) -> ee.Image:
        """Computes the NDVI for the input Image

        Args:
            image (ee.Image): Image to calculate NDVI

        Returns:
            ee.Image: a Image that represents the NDVI values
        """
        return image.normalizedDifference([self.nir, self.red]).rename(self.name)

compute(self, image)

Computes the NDVI for the input Image

Parameters:

Name	Type	Description	Default
image	ee.Image	Image to calculate NDVI	required

Returns:

Type	Description
ee.Image	a Image that represents the NDVI values

Source code in eegeolab/calculators.py

def compute(self, image: ee.Image) -> ee.Image:
    """Computes the NDVI for the input Image

    Args:
        image (ee.Image): Image to calculate NDVI

    Returns:
        ee.Image: a Image that represents the NDVI values
    """
    return image.normalizedDifference([self.nir, self.red]).rename(self.name)

---

Last update: 2023-10-13
Created: 2023-10-13