iris.nodes.aggregation package

Submodules

iris.nodes.aggregation.noise_mask_union module

class iris.nodes.aggregation.noise_mask_union.NoiseMaskUnion(**kwargs: Any)

Bases: Algorithm

Aggregate several NoiseMask into one by computing their union. I.E. For every bit of the NoiseMask, the output is an OR of the same bit across all NoiseMasks.

run(elements: List[NoiseMask]) → NoiseMask

Compute the union of a list of NoiseMask.

Parameters:

elements (List[NoiseMask]) – input NoiseMasks.

Raises:

ValueError – if not all NoiseMask.mask do not have the same shape.

Returns:

aggregated NoiseMasks

Return type:

NoiseMask

Module contents