scludam.masker module

Module for helper masking functions.

class scludam.masker.DataMasker[source]

Bases: object

Abstract class for data masking.

abstract mask(data) → ndarray[source]

Mask data.

Parameters:: data (np.ndarray) – Data to mask.
Returns:: Boolean array.
Return type:: np.ndarray

class scludam.masker.RangeMasker(limits: list | ndarray)[source]

Bases: DataMasker

Mask data outsude a hypercube according to limits.

Variables:: limits (Union[np.ndarray, list]) – Limits of the hypercube as [[dim1_min, dim1_max], [dim2_min, dim2_max], ...].

mask(data: ndarray)[source]

Mask the data.

Parameters:: data (np.ndarray) – data to be masked.
Returns:: Mask as 1D boolean array
Return type:: np.ndarray
Raises:: ValueError – If limits do not have the correct shape.