Documents · Verb reference

vase_extract

Mask a cube so that values outside the vase become NaN.

Callable type: Direct helper function · Browse: Spatial and alignment

Call this helper directly with the documented data arguments; it does not return a configured pipe stage. Use v.apply(...) or an explicit callable if composition is needed.

Usage

from cubedynamics import verbs as v
v.vase_extract(cube, vase, time_dim='time', y_dim='y', x_dim='x')

Arguments

Argument	Meaning	Default
cube	See implementation docstring below; no parameter-specific description supplied.	required
vase	See implementation docstring below; no parameter-specific description supplied.	required
time_dim	See implementation docstring below; no parameter-specific description supplied.	'time'
y_dim	See implementation docstring below; no parameter-specific description supplied.	'y'
x_dim	See implementation docstring below; no parameter-specific description supplied.	'x'

Accepts

FireEventDaily / FireHull or VaseDefinition geometry and/or an observed climate cube, as specified by the arguments. Match CRS and event dates before attribution.

Returns

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

Order / grammar behavior

Construct and validate event geometry before attributing climate or rendering. Fire plotting still uses a Plotly hull backend; it is not the general HTML cube viewer.

Minimal example

Follow the real FIRED event and streamed gridMET example. It provides the event acquisition, geometry, climate loading and plots together; a climate cube alone is insufficient for this operation.

Works with