Documents · Verb reference

ndvi_from_s2

Factory returning a Sentinel-2 NDVI transform for pipe chains.

Callable type: Grammar verb / pipe stage · Browse: Transform

Usage

from cubedynamics import verbs as v
v.ndvi_from_s2(nir_band='B08', red_band='B04')

Arguments

Argument	Meaning	Default
nir_band	See implementation docstring below; no parameter-specific description supplied.	'B08'
red_band	See implementation docstring below; no parameter-specific description supplied.	'B04'

Accepts

A Sentinel-2 cube containing the specified NIR and red bands, not an already-derived NDVI cube.

Returns

The public docstring does not specify a return contract. Do not assume a pipe-ready return; consult the linked implementation.

Order / grammar behavior

A pipe passes the preceding result to the next callable. Confirm that the previous step's dimensions and semantic state satisfy the input contract. Reductions can remove dimensions; plotting may produce side effects.

Minimal example

The Sentinel-2 NDVI recipe loads observed bands and applies this transform. Check scaling and cloud limitations in the source reference.

Works with