Documents · Verb reference
severity_synchrony
Measure magnitude co-variation during jointly active states.
Callable type: Grammar verb / pipe stage · Browse: Synchrony and comparison
Usage
from cubedynamics import verbs as v
v.severity_synchrony(*, magnitude_var='magnitude', state_var='state', condition='joint', method='spearman', spatial_mode='neighbors', radius_km=None, k_neighbors=None, reference=None, min_joint_events=10, window=None, stride=None)
Arguments
| Argument | Meaning | Default |
|---|---|---|
| magnitude_var | See implementation docstring below; no parameter-specific description supplied. | 'magnitude' |
| state_var | See implementation docstring below; no parameter-specific description supplied. | 'state' |
| condition | See implementation docstring below; no parameter-specific description supplied. | 'joint' |
| method | See implementation docstring below; no parameter-specific description supplied. | 'spearman' |
| spatial_mode | See implementation docstring below; no parameter-specific description supplied. | 'neighbors' |
| radius_km | See implementation docstring below; no parameter-specific description supplied. | None |
| k_neighbors | See implementation docstring below; no parameter-specific description supplied. | None |
| reference | See implementation docstring below; no parameter-specific description supplied. | None |
| min_joint_events | See implementation docstring below; no parameter-specific description supplied. | 10 |
| window | See implementation docstring below; no parameter-specific description supplied. | None |
| stride | See implementation docstring below; no parameter-specific description supplied. | None |
Accepts
State cube -> synchrony Dataset with joint-observation diagnostics.
Returns
State cube -> synchrony Dataset with joint-observation diagnostics.
Order / grammar behavior
State cube -> synchrony Dataset with joint-observation diagnostics.
Minimal example
Run from the repository root after python -m pip install -e '.[vignettes]'. Uses the checked observational PRISM fixture; no network is required.
from pathlib import Path
import xarray as xr
import matplotlib.pyplot as plt
from cubedynamics import pipe, verbs as v
# Frozen, reviewed PRISM observations; run from the repository root.
path = Path("tests/fixtures/real_data/prism_boulder_january_2024.nc")
with xr.open_dataset(path, engine="scipy") as observed:
cube = observed["tmax"].load()
assert cube.attrs["units"] == "degC"
state = (pipe(cube) | v.threshold_state(threshold=0, direction="below")).unwrap()
result = (pipe(state) | v.severity_synchrony(spatial_mode="reference", reference="center", min_joint_events=3)).unwrap()
result["severity_synchrony"].squeeze().plot()
plt.show()
Works with
State cube -> synchrony Dataset with joint-observation diagnostics.
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.