Skip to content

Documents · Verb reference

fire_derivative

Fire derivative hull visualization verb.

Callable type: Visualization helper (direct call) · Browse: Visualization

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.fire_derivative(da=None, *, fired_daily, event_id, order=1, n_ring_samples=200, n_theta=296, save_prefix=None)

Arguments

Argument Meaning Default
da Currently unused. Included so this function can be used in a CubeDynamics pipeline, e.g.: pipe(ndvi) | v.fire_derivative(fired_daily=..., event_id=...) None
fired_daily FIRED daily GeoDataFrame with 'id', 'date', and 'geometry' columns. required
event_id Event ID in fired_daily. required
order 1 for speed hull, 2 for acceleration hull. 1
n_ring_samples Geometry resolution parameters forwarded to compute_time_hull_geometry. 200
n_theta Geometry resolution parameters forwarded to compute_time_hull_geometry. 296
save_prefix Optional filename stem to save a PNG/PDF of the derivative hull using Plotly static image export (requires kaleido). None

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

dict { "event": FireEventDaily, "base_hull": TimeHull, "derivative_hull": TimeHull, "fig": go.Figure, }

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

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

See also

Implementation notes

No additional implementation notes in the current docstring.

Implementation source. Signatures and descriptions on this page are generated from this checkout, not hand-maintained copies.