arpes.analysis.mask.apply_mask_to_coords#

arpes.analysis.mask.apply_mask_to_coords(data, mask, dims, *, invert=True)[source]#

Performs broadcasted masking along a given dimension.

Parameters:
  • data – The data you want to mask.

  • mask – The mask to apply, should be dimensionally equivalent to what you request in dims.

  • dims – The dimensions which should be masked.

  • invert – Whether the mask should be inverted.

Returns:

The masked data.