prose.Fluxes.mask_stars#

Fluxes.mask_stars(mask: array, keep_indexing: bool = True)[source]#

Mask stars fluxes.

In order to keep indexing, the fluxes are set to -1.

Parameters:
  • mask (np.array) – A boolean array of the same length as the number of stars, indicating which fluxes should be masked

  • remove (bool, optional) – whether to keep indexing (recommended) and only set pixels to 1, by default False

Returns:

A new Fluxes instance with masked stars

Return type:

Fluxes