API Reference

Here you will find all spyndex methods:

spyndex.spyndex

Core module of spyndex. All functions here are automatically loaded with import spyndex and can be called from it (e.g., spyndex.computeIndex()):

computeIndex(index[, params, online, ...])	Computes one or more Spectral Indices from the Awesome Spectral Indices list.
computeKernel(kernel[, params])	Computes a kernel k(a,b).

spyndex.axioms

Axioms module of spyndex. Automatically loaded with import spyndex. Spectral Indices, Constants and Bands can be accessed from the module (e.g. spyndex.indices.NDVI, spyndex.bands.B, spyndex.constants.L):

SpectralIndices(*args, default_box, ...)	Spectral Indices object.
SpectralIndex(index)	Spectral Index object.
Bands(*args, default_box, default_box_attr, ...)	Bands object.
Band(band)	Band object.
PlatformBand(platform_band)	Platform Band object.
Constants(*args, default_box, ...)	Constants object.
Constant(constant)	Constant object.

spyndex.datasets

Example datasets. Automatically loaded with import spyndex. Functions from this module can be loaded from the module (e.g., spyndex.datasets.open()):

open(dataset)

Opens a dataset.

spyndex.plot

Plotting indices. Automatically loaded with import spyndex. Functions from this module can be loaded from the module (e.g., spyndex.plot.heatmap()):

heatmap(index, x, y[, params, online])

Plot all posible index values as a color-encoded matrix.