TurbulentRegionsBySeverity#
- class rojak.turbulence.analysis.TurbulentRegionsBySeverity(computed_diagnostic, pressure_levels, severities, thresholds, threshold_mode, has_parent=False)[source]#
Computes turbulent regions by severity for a given turbulence diagnostic
Based on the thresholds for a given turbulence diagnostic, performs a binary classification of whether turbulence is present.
- Parameters:
computed_diagnostic (DataArray)
severities (list[TurbulenceSeverity])
thresholds (TurbulenceThresholds)
threshold_mode (TurbulenceThresholdMode)
has_parent (bool)
- __init__(computed_diagnostic, pressure_levels, severities, thresholds, threshold_mode, has_parent=False)[source]#
- Parameters:
computed_diagnostic (DataArray) – Computed diagnostic values
pressure_levels (list[float]) – Pressure levels to compute turbulent regions for
severities (list[TurbulenceSeverity]) – Turbulence severities to compute the boolean mask for
thresholds (TurbulenceThresholds) – Thresholds used to determine each severity
threshold_mode (TurbulenceThresholdMode) – Whether the thresholds are bounded intervals or lower bounds
has_parent (bool) – If
True, results for each severity are returned lazily (uncomputed) as a list rather than concatenated and computed. Set when this post processor is used as a component of another post processor (e.g.TurbulenceProbabilityBySeverity). Defaults toFalse.
- Return type:
None
Methods
__init__(computed_diagnostic, ...[, has_parent])execute()Compute the boolean turbulent region mask for each severity in
self._severities