Documents · Verb reference

extract

Attach canonical fire hull and climate summaries to a cube.

Callable type: Grammar verb / pipe stage · Browse: Spatial and alignment

Usage

from cubedynamics import verbs as v
v.extract(da=None, *, fired_event, date_col='date', n_ring_samples=100, n_theta=96, verbose=False)

Arguments

Argument	Meaning	Default
da	See implementation docstring below; no parameter-specific description supplied.	None
fired_event	See implementation docstring below; no parameter-specific description supplied.	required
date_col	See implementation docstring below; no parameter-specific description supplied.	'date'
n_ring_samples	See implementation docstring below; no parameter-specific description supplied.	100
n_theta	See implementation docstring below; no parameter-specific description supplied.	96
verbose	See implementation docstring below; no parameter-specific description supplied.	False

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