sorcha.modules.PPFadingFunctionFilter

Functions

PPFadingFunctionFilter(observations, fillfactor, ...)

Wrapper function for PPDetectionProbability and PPDropObservations.

Module Contents

PPFadingFunctionFilter(observations, fillfactor, width, module_rngs, verbose=False)[source]

Wrapper function for PPDetectionProbability and PPDropObservations.

Calculates detection probability based on a fading function, then drops rows where the probabilty of detection is less than sample drawn from a uniform distribution.

Parameters:

  • observations (Pandas dataframe) -- Dataframe of observations with a column containing the probability of detection.

  • fillfactor (float) -- Fraction of camera field-of-view covered by detectors

  • module_rngs (PerModuleRNG) -- A collection of random number generators (per module).

  • verbose (boolean, default=False) -- Verbose logging flag.

Returns:

observations_drop -- Modified 'observations' dataframe without observations that could not be observed.

Return type:

Pandas dataframe)