sorcha.modules.DESFadingFunctionFilter

Functions

DESFadingFunctionFilter(observations, ...[, verbose])

Wrapper function for DESDetectionProbability and PPDropObservations.

Module Contents

DESFadingFunctionFilter(observations, transient_efficiency, module_rngs, verbose=False)[source]

Wrapper function for DESDetectionProbability 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.

  • transient_efficiency (float) -- overall transient efficiency for moving object detection

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

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

Returns:

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

Return type:

Pandas dataframe)