earthlib.SoilPVNPV

Methods for running Soil / Photosynthetic Vegetation / Non-Photosynthetic Vegetation unmixing.

ASTER(img, bands=getBands('ASTER'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix an ASTER image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('ASTER')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def ASTER(
    img: ee.Image,
    bands: list = getBands("ASTER"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix an ASTER image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "ASTER"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

AVNIR2(img, bands=getBands('AVNIR2'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix an AVNIR2 image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('AVNIR2')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def AVNIR2(
    img: ee.Image,
    bands: list = getBands("AVNIR2"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix an AVNIR2 image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "AVNIR2"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

DoveR(img, bands=getBands('DoveR'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat8 image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('DoveR')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def DoveR(
    img: ee.Image,
    bands: list = getBands("DoveR"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat8 image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "DoveR"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Landsat457(img, bands=getBands('Landsat7'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat4 image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('Landsat7')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def Landsat457(
    img: ee.Image,
    bands: list = getBands("Landsat7"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat4 image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "Landsat7"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Landsat8(img, bands=getBands('Landsat8'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Landsat8 image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('Landsat8')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def Landsat8(
    img: ee.Image,
    bands: list = getBands("Landsat8"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Landsat8 image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "Landsat8"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

MODIS(img, bands=getBands('MODIS'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a MODIS image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('MODIS')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def MODIS(
    img: ee.Image,
    bands: list = getBands("MODIS"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a MODIS image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "MODIS"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

NEON(img, bands=getBands('NEON'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a NEON image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('NEON')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def NEON(
    img: ee.Image,
    bands: list = getBands("NEON"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a NEON image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "NEON"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

PlanetScope(img, bands=getBands('PlanetScope'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a PlanetScope image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('PlanetScope')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def PlanetScope(
    img: ee.Image,
    bands: list = getBands("PlanetScope"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a PlanetScope image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "PlanetScope"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

Sentinel2(img, bands=getBands('Sentinel2'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a Sentinel2 image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('Sentinel2')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def Sentinel2(
    img: ee.Image,
    bands: list = getBands("Sentinel2"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a Sentinel2 image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "Sentinel2"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

SuperDove(img, bands=getBands('SuperDove'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a SuperDove image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('SuperDove')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def SuperDove(
    img: ee.Image,
    bands: list = getBands("SuperDove"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a SuperDove image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "SuperDove"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

VIIRS(img, bands=getBands('VIIRS'), n=N_ITERATIONS, shade_normalize=SHADE_NORMALIZE)

Unmix a VIIRS image with soil, pv, npv endmembers.

Parameters:

Name	Type	Description	Default
img	Image	the ee.Image to unmix	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	getBands('VIIRS')
n	int	the number of iterations for unmixing.	N_ITERATIONS
shade_normalize	bool	apply shade normalization during unmixing. reduces the influences of brightness and illumination geometry.	SHADE_NORMALIZE

Returns:

Name	Type	Description
unmixed	Image	a 3-band image with bands (%soil, %pv, %npv).

Source code in earthlib/SoilPVNPV.py

def VIIRS(
    img: ee.Image,
    bands: list = getBands("VIIRS"),
    n: int = N_ITERATIONS,
    shade_normalize: bool = SHADE_NORMALIZE,
) -> ee.Image:
    """Unmix a VIIRS image with soil, pv, npv endmembers.

    Args:
        img: the ee.Image to unmix
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.
        shade_normalize: apply shade normalization during unmixing.
            reduces the influences of brightness and illumination geometry.

    Returns:
        unmixed: a 3-band image with bands (%soil, %pv, %npv).
    """
    sensor = "VIIRS"
    n_bands = len(bands)
    endmembers = getEndmembers(sensor, bands, n)
    unmixed = fractionalCover(
        img,
        endmembers,
        endmember_names=ENDMEMBER_NAMES,
        shade_normalize=shade_normalize,
        n_bands=n_bands,
    )

    return unmixed

bySensor(sensor)

Returns the appropriate scaling function to use by sensor type.

Parameters:

Name	Type	Description	Default
sensor	str	string with the sensor name to return (e.g. "Landsat8", "Sentinel2").	required

Returns:

Type	Description
Callable	the scale function associated with a sensor to pass to an ee .map() call

Source code in earthlib/SoilPVNPV.py

def bySensor(sensor: str) -> Callable:
    """Returns the appropriate scaling function to use by sensor type.

    Args:
        sensor: string with the sensor name to return (e.g. "Landsat8", "Sentinel2").

    Returns:
        the scale function associated with a sensor to pass to an ee .map() call
    """
    lookup = {
        "ASTER": ASTER,
        "AVNIR2": AVNIR2,
        "DoveR": DoveR,
        "Landsat4": Landsat457,
        "Landsat5": Landsat457,
        "Landsat7": Landsat457,
        "Landsat8": Landsat8,
        "MODIS": MODIS,
        "NEON": NEON,
        "PlanetScope": PlanetScope,
        "Sentinel2": Sentinel2,
        "SuperDove": SuperDove,
        "VIIRS": VIIRS,
    }
    try:
        function = lookup[sensor]
        return function
    except KeyError:
        supported = ", ".join(lookup.keys())
        raise SensorError(
            f"Scaling adjustment not supported for '{sensor}'. Supported: {supported}"
        )

getEndmembers(sensor, bands, n=N_ITERATIONS)

Get a series of ee.List objects with the SoilPVNPV endmembers.

Parameters:

Name	Type	Description	Default
sensor	str	the name of the sensor (from earthlib.listSensors()).	required
bands	list	a list of bands to select (from earthlib.getBands(sensor)).	required
n	int	the number of iterations for unmixing.	N_ITERATIONS

Returns:

Type	Description
Tuple[list]	(soil, pv, npv) endmembers

Source code in earthlib/SoilPVNPV.py

def getEndmembers(sensor: str, bands: list, n: int = N_ITERATIONS) -> Tuple[list]:
    """Get a series of ee.List objects with the SoilPVNPV endmembers.

    Args:
        sensor: the name of the sensor (from earthlib.listSensors()).
        bands: a list of bands to select (from earthlib.getBands(sensor)).
        n: the number of iterations for unmixing.

    Returns:
        (soil, pv, npv) endmembers
    """
    soil_list = selectSpectra("bare", sensor, n, bands)
    pv_list = selectSpectra("vegetation", sensor, n, bands)
    npv_list = selectSpectra("npv", sensor, n, bands)
    soil = [ee.List(soil_spectra.tolist()) for soil_spectra in soil_list]
    pv = [ee.List(pv_spectra.tolist()) for pv_spectra in pv_list]
    npv = [ee.List(npv_spectra.tolist()) for npv_spectra in npv_list]

    return soil, pv, npv