meridian.analysis.review.configs.ROIConsistencyConfig

Configuration for the ROI Consistency Check.

Inherits From: ChannelCheckConfig, BaseConfig

meridian.analysis.review.configs.ROIConsistencyConfig(
    failing_channels_threshold: (int | None) = None,
    failing_channels_ratio_threshold: (float | None) = None,
    prior_lower_quantile: float = 0.01,
    prior_upper_quantile: float = 0.99
)

This check verifies if the posterior mean of the ROI falls within a reasonable range of the prior distribution.

prior_lower_quantile The lower quantile of the ROI prior distribution to define the lower bound of the reasonable range.
prior_upper_quantile The upper quantile of the ROI prior distribution to define the upper bound of the reasonable range.
failing_channels_threshold Dataclass field
failing_channels_ratio_threshold Dataclass field

Methods

is_failing_channels_within_threshold

View source

is_failing_channels_within_threshold(
    n_failing: int, n_total: int
) -> bool

Checks if the number and ratio of failing channels are within threshold.

If both thresholds are specified, the check passes if EITHER condition is satisfied (or both). If no threshold is set, returns True only when n_failing == 0.

Args
n_failing The number of failing channels.
n_total The total number of channels evaluated.

Returns
True if the failing channels are within the tolerance threshold(s), False otherwise.

__eq__

__eq__(
    other
)

Return self==value.

failing_channels_ratio_threshold None
failing_channels_threshold None
prior_lower_quantile 0.01
prior_upper_quantile 0.99