sorcha.modules.PPDetectionEfficiency

Functions

PPDetectionEfficiency(padain, threshold, module_rngs)

Applies a random cut to the observations dataframe based on an efficiency

Module Contents

PPDetectionEfficiency(padain, threshold, module_rngs)[source]

Applies a random cut to the observations dataframe based on an efficiency threshold: if the threshold is 0.95, for example, 5% of observations will be randomly dropped. Used by PPLinkingFilter.

Parameters:

  • padain (Pandas dataframe) -- Dataframe of observations.

  • threshold (float) -- Fraction between 0 and 1 of detections retained in the dataframe.

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

Returns:

Dataframe of observations with a fraction equal to 1-threshold randomly dropped.

Return type:

Pandas dataframe