ezmsg.sigproc.aggregate

Functions

ranged_aggregate(axis=None, bands=None, operation=AggregationFunction.MEAN)

Apply an aggregation operation over one or more bands.

Parameters:

• axis (str | None) – The name of the axis along which to apply the bands.

• bands (list[tuple[float, float]] | None) – [(band1_min, band1_max), (band2_min, band2_max), …] If not set then this acts as a passthrough node.

• operation (AggregationFunction) – AggregationFunction to apply to each band.

Returns:

RangedAggregateTransformer

Return type:

RangedAggregateTransformer

Classes

class AggregationFunction(*values)

Bases: OptionsEnum

Enum for aggregation functions available to be used in ranged_aggregate operation.

NONE = 'None (all)'

MAX = 'max'

MIN = 'min'

MEAN = 'mean'

MEDIAN = 'median'

STD = 'std'

SUM = 'sum'

NANMAX = 'nanmax'

NANMIN = 'nanmin'

NANMEAN = 'nanmean'

NANMEDIAN = 'nanmedian'

NANSTD = 'nanstd'

NANSUM = 'nansum'

ARGMIN = 'argmin'

ARGMAX = 'argmax'

TRAPEZOID = 'trapezoid'

class RangedAggregate(*args, settings=None, **kwargs)

Bases: BaseTransformerUnit[RangedAggregateSettings, AxisArray, AxisArray, RangedAggregateTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of RangedAggregateSettings

class RangedAggregateSettings(axis=None, bands=None, operation=AggregationFunction.MEAN)

Bases: Settings

Settings for RangedAggregate.

Parameters:

• axis (str | None)

• bands (list[tuple[float, float]] | None)

• operation (AggregationFunction)

axis: str | None = None

The name of the axis along which to apply the bands.

bands: list[tuple[float, float]] | None = None

[(band1_min, band1_max), (band2_min, band2_max), …] If not set then this acts as a passthrough node.

operation: AggregationFunction = 'mean'

AggregationFunction to apply to each band.

__init__(axis=None, bands=None, operation=AggregationFunction.MEAN)

Parameters:

• axis (str | None)

• bands (list[tuple[float, float]] | None)

• operation (AggregationFunction)

Return type:

None

class RangedAggregateState

Bases: object

slices: list[tuple[Any, ...]] | None = None

out_axis: AxisBase | None = None

ax_vec: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

class RangedAggregateTransformer(*args, **kwargs)

Bases: BaseStatefulTransformer[RangedAggregateSettings, AxisArray, AxisArray, RangedAggregateState]

class AggregationFunction(*values)

Bases: OptionsEnum

Enum for aggregation functions available to be used in ranged_aggregate operation.

NONE = 'None (all)'

MAX = 'max'

MIN = 'min'

MEAN = 'mean'

MEDIAN = 'median'

STD = 'std'

SUM = 'sum'

NANMAX = 'nanmax'

NANMIN = 'nanmin'

NANMEAN = 'nanmean'

NANMEDIAN = 'nanmedian'

NANSTD = 'nanstd'

NANSUM = 'nansum'

ARGMIN = 'argmin'

ARGMAX = 'argmax'

TRAPEZOID = 'trapezoid'

class RangedAggregateSettings(axis=None, bands=None, operation=AggregationFunction.MEAN)

Bases: Settings

Settings for RangedAggregate.

Parameters:

• axis (str | None)

• bands (list[tuple[float, float]] | None)

• operation (AggregationFunction)

axis: str | None = None

The name of the axis along which to apply the bands.

bands: list[tuple[float, float]] | None = None

[(band1_min, band1_max), (band2_min, band2_max), …] If not set then this acts as a passthrough node.

operation: AggregationFunction = 'mean'

AggregationFunction to apply to each band.

__init__(axis=None, bands=None, operation=AggregationFunction.MEAN)

Parameters:

• axis (str | None)

• bands (list[tuple[float, float]] | None)

• operation (AggregationFunction)

Return type:

None

class RangedAggregateState

Bases: object

slices: list[tuple[Any, ...]] | None = None

out_axis: AxisBase | None = None

ax_vec: ndarray[tuple[Any, ...], dtype[_ScalarT]] | None = None

class RangedAggregateTransformer(*args, **kwargs)

Bases: BaseStatefulTransformer[RangedAggregateSettings, AxisArray, AxisArray, RangedAggregateState]

class RangedAggregate(*args, settings=None, **kwargs)

Bases: BaseTransformerUnit[RangedAggregateSettings, AxisArray, AxisArray, RangedAggregateTransformer]

Parameters:

settings (Settings | None)

SETTINGS

alias of RangedAggregateSettings

ranged_aggregate(axis=None, bands=None, operation=AggregationFunction.MEAN)

Apply an aggregation operation over one or more bands.

Parameters:

• axis (str | None) – The name of the axis along which to apply the bands.

• bands (list[tuple[float, float]] | None) – [(band1_min, band1_max), (band2_min, band2_max), …] If not set then this acts as a passthrough node.

• operation (AggregationFunction) – AggregationFunction to apply to each band.

Returns:

RangedAggregateTransformer

Return type:

RangedAggregateTransformer