dataeval.metrics.stats.ChannelStatsOutput¶

class dataeval.metrics.stats.ChannelStatsOutput¶

Output class for imagestats() stats metric with per_channel=True.

This class represents the outputs of various per-channel stats functions against a single dataset, such that each index across all stat outputs are representative of the same source image. Modifying or mixing outputs will result in inaccurate outlier calculations if not created correctly.

The attributes and methods are a superset of PixelStatsOutput and VisualStatsOutput.

get_channel_mask(channel_index, channel_count=None)¶

Boolean mask for results filtered to specified channel index and optionally the count of the channels per image.

Parameters:¶

channel_index : int | Iterable[int] | None¶

Index or indices of channel(s) to filter for

channel_count : int | Iterable[int] | None¶

Optional count(s) of channels to filter for

Return type:¶

list[bool]

meta()¶

Metadata about the execution of the function or method for the Output class.

Return type:¶

ExecutionMetadata