cubie.outputhandling.summarymetrics

Summary metrics.

This module provides a collection of summary metrics for calculating statistics during integration.

cubie.outputhandling.summarymetrics.register_metric(registry)[source]

Decorator factory for registering summary metrics.

Parameters:

registry (SummaryMetrics) – The registry instance to register the metric with.

Returns:

Decorator function that registers a metric class.

Return type:

callable

Notes

This decorator automatically creates an instance of the decorated class and registers it with the provided registry.

Modules

max

Maximum value summary metric for CUDA-accelerated batch integration.

mean

Mean value summary metric for CUDA-accelerated batch integration.

metrics

Summary metrics system for CUDA-accelerated batch integration.

peaks

Peak detection summary metric for CUDA-accelerated batch integration.

rms

Root Mean Square (RMS) summary metric for CUDA-accelerated batch integration.