summary_metrics

cubie.outputhandling.summarymetrics.summary_metrics: SummaryMetrics = SummaryMetrics(precision=<class 'numpy.float32'>, _names=['mean', 'max', 'rms', 'peaks', 'std', 'min', 'max_magnitude', 'extrema', 'negative_peaks', 'mean_std_rms', 'mean_std', 'std_rms', 'dxdt_max', 'dxdt_min', 'dxdt_extrema', 'd2xdt2_max', 'd2xdt2_min', 'd2xdt2_extrema'], _buffer_sizes={'mean': 1, 'max': 1, 'rms': 1, 'peaks': <function Peaks.__init__.<locals>.<lambda>>, 'std': 3, 'min': 1, 'max_magnitude': 1, 'extrema': 2, 'negative_peaks': <function NegativePeaks.__init__.<locals>.<lambda>>, 'mean_std_rms': 3, 'mean_std': 3, 'std_rms': 3, 'dxdt_max': 2, 'dxdt_min': 2, 'dxdt_extrema': 3, 'd2xdt2_max': 3, 'd2xdt2_min': 3, 'd2xdt2_extrema': 4}, _output_sizes={'mean': 1, 'max': 1, 'rms': 1, 'peaks': <function Peaks.__init__.<locals>.<lambda>>, 'std': 1, 'min': 1, 'max_magnitude': 1, 'extrema': 2, 'negative_peaks': <function NegativePeaks.__init__.<locals>.<lambda>>, 'mean_std_rms': 3, 'mean_std': 2, 'std_rms': 2, 'dxdt_max': 1, 'dxdt_min': 1, 'dxdt_extrema': 2, 'd2xdt2_max': 1, 'd2xdt2_min': 1, 'd2xdt2_extrema': 2}, _metric_objects={'mean': <cubie.outputhandling.summarymetrics.mean.Mean object>, 'max': <cubie.outputhandling.summarymetrics.max.Max object>, 'rms': <cubie.outputhandling.summarymetrics.rms.RMS object>, 'peaks': <cubie.outputhandling.summarymetrics.peaks.Peaks object>, 'std': <cubie.outputhandling.summarymetrics.std.Std object>, 'min': <cubie.outputhandling.summarymetrics.min.Min object>, 'max_magnitude': <cubie.outputhandling.summarymetrics.max_magnitude.MaxMagnitude object>, 'extrema': <cubie.outputhandling.summarymetrics.extrema.Extrema object>, 'negative_peaks': <cubie.outputhandling.summarymetrics.negative_peaks.NegativePeaks object>, 'mean_std_rms': <cubie.outputhandling.summarymetrics.mean_std_rms.MeanStdRms object>, 'mean_std': <cubie.outputhandling.summarymetrics.mean_std.MeanStd object>, 'std_rms': <cubie.outputhandling.summarymetrics.std_rms.StdRms object>, 'dxdt_max': <cubie.outputhandling.summarymetrics.dxdt_max.DxdtMax object>, 'dxdt_min': <cubie.outputhandling.summarymetrics.dxdt_min.DxdtMin object>, 'dxdt_extrema': <cubie.outputhandling.summarymetrics.dxdt_extrema.DxdtExtrema object>, 'd2xdt2_max': <cubie.outputhandling.summarymetrics.d2xdt2_max.D2xdt2Max object>, 'd2xdt2_min': <cubie.outputhandling.summarymetrics.d2xdt2_min.D2xdt2Min object>, 'd2xdt2_extrema': <cubie.outputhandling.summarymetrics.d2xdt2_extrema.D2xdt2Extrema object>}, _params={'mean': 0, 'max': 0, 'rms': 0, 'peaks': 0, 'std': 0, 'min': 0, 'max_magnitude': 0, 'extrema': 0, 'negative_peaks': 0, 'mean_std_rms': 0, 'mean_std': 0, 'std_rms': 0, 'dxdt_max': 0, 'dxdt_min': 0, 'dxdt_extrema': 0, 'd2xdt2_max': 0, 'd2xdt2_min': 0, 'd2xdt2_extrema': 0}, _combined_metrics={frozenset({'mean', 'std', 'rms'}): 'mean_std_rms', frozenset({'mean', 'std'}): 'mean_std', frozenset({'rms', 'std'}): 'std_rms', frozenset({'min', 'max'}): 'extrema', frozenset({'dxdt_min', 'dxdt_max'}): 'dxdt_extrema', frozenset({'d2xdt2_min', 'd2xdt2_max'}): 'd2xdt2_extrema'})

Registry and dispatcher for summary metrics.

cubie.outputhandling.summarymetrics._names

list[str]. Registered metric names.

cubie.outputhandling.summarymetrics._buffer_sizes

dict[str, int | Callable]. Buffer size requirements keyed by name.

cubie.outputhandling.summarymetrics._output_sizes

dict[str, int | Callable]. Output size requirements keyed by name.

cubie.outputhandling.summarymetrics._metric_objects

dict[str, SummaryMetric]. Registered metric instances.

cubie.outputhandling.summarymetrics._params

dict[str, Any]. Parameters parsed from configuration strings.

Notes

Methods only report information for metrics explicitly requested so the caller can compile device functions tailored to the active configuration.