sorcha.modules.PPBrightLimit

Functions

PPBrightLimit(observations, observing_filters, ...)

Drops observations brighter than the user-defined saturation

Module Contents

PPBrightLimit(observations, observing_filters, bright_limit)[source]

Drops observations brighter than the user-defined saturation limit. Can take either a single saturation limit for a straight cut, or filter-specific saturation limits.

Parameters:
  • observations (Pandas dataframe) -- Dataframe of observations.

  • observing_filters (list of strings) -- Observing filters present in the data.

  • bright_limit (float or list of floats) -- Saturation limits: either single value applied to all filters or a list of values for each filter.

Returns:

observations_out -- observations dataframe modified with rows dropped for apparent magnitudes brigher than the bright_limit for the given observation's filter

Return type:

Pandas dataframe