Documents · Verb reference

fire_vase_panel

Build a multi-event VASE panel for prescribed burns.

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

Usage

from cubedynamics import verbs as v
v.fire_vase_panel(da=None, *, fired_daily, fired_events=None, event_ids=None, prescribed_column=None, prescribed_values=None, prescribed_pattern='prescrib|\\brx\\b|planned|broadcast|pile', id_col=None, event_id_col=None, date_col=None, min_days=1, max_days=None, max_events=None, columns=3, climate_loader=None, load_climate=False, climate_variable='vpd', time_buffer_days=1, n_ring_samples=96, n_theta=96, fast=True, allow_synthetic=False, prefer_streaming=True, continue_on_error=True, title='Prescribed fire VASE panel', shared_colorbar=True, **fire_plot_kwargs)

Arguments

Argument	Meaning	Default
da	See implementation docstring below; no parameter-specific description supplied.	None
fired_daily	See implementation docstring below; no parameter-specific description supplied.	required
fired_events	See implementation docstring below; no parameter-specific description supplied.	None
event_ids	See implementation docstring below; no parameter-specific description supplied.	None
prescribed_column	See implementation docstring below; no parameter-specific description supplied.	None
prescribed_values	See implementation docstring below; no parameter-specific description supplied.	None
prescribed_pattern	See implementation docstring below; no parameter-specific description supplied.	'prescrib\|\brx\b\|planned\|broadcast\|pile'
id_col	See implementation docstring below; no parameter-specific description supplied.	None
event_id_col	See implementation docstring below; no parameter-specific description supplied.	None
date_col	See implementation docstring below; no parameter-specific description supplied.	None
min_days	See implementation docstring below; no parameter-specific description supplied.	1
max_days	See implementation docstring below; no parameter-specific description supplied.	None
max_events	See implementation docstring below; no parameter-specific description supplied.	None
columns	See implementation docstring below; no parameter-specific description supplied.	3
climate_loader	See implementation docstring below; no parameter-specific description supplied.	None
load_climate	See implementation docstring below; no parameter-specific description supplied.	False
climate_variable	See implementation docstring below; no parameter-specific description supplied.	'vpd'
time_buffer_days	See implementation docstring below; no parameter-specific description supplied.	1
n_ring_samples	See implementation docstring below; no parameter-specific description supplied.	96
n_theta	See implementation docstring below; no parameter-specific description supplied.	96
fast	See implementation docstring below; no parameter-specific description supplied.	True
allow_synthetic	See implementation docstring below; no parameter-specific description supplied.	False
prefer_streaming	See implementation docstring below; no parameter-specific description supplied.	True
continue_on_error	See implementation docstring below; no parameter-specific description supplied.	True
title	See implementation docstring below; no parameter-specific description supplied.	'Prescribed fire VASE panel'
shared_colorbar	See implementation docstring below; no parameter-specific description supplied.	True
fire_plot_kwargs	See implementation docstring below; no parameter-specific description supplied.	forwarded arguments

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