sorcha.modules.PPDropObservations

Functions

PPDropObservations(observations, module_rngs[, ...])

Drops rows where the probabilty of detection is less than sample drawn

Module Contents

PPDropObservations(observations, module_rngs, probability='detection probability')[source]

Drops rows where the probabilty of detection is less than sample drawn from a uniform distribution. Used by PPFadingFunctionFilter and DESFadingFunctionFilter.

Parameters:

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

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

  • probability (string, default="detection probability") -- Name of column containing detection probability.

Returns:

out -- New dataframe of 'observations' modified to remove observations that could not be observed.

Return type:

Pandas dataframe