semantique.processor.arrays.Array.filter

Array.filter(filterer, track_types=True, **kwargs)

Apply the filter verb to the array.

The filter verb filters the values in an array.

Parameters:

• filterer (xarray.DataArray) – Binary array which can be aligned to the same shape as the input array. Each pixel in the input array will be kept if the pixel in the filterer with the same dimension coordinates is true, and dropped otherwise (i.e. assigned a nodata value).

• track_types (bool) – Should it be checked that the filterer has value type binary?

• **kwargs – Ignored.

Returns:

xarray.DataArray

Raises:

exceptions.InvalidValueTypeError – If track_types = True and the value type of filterer is not binary.