sorcha.modules.PPDetectionProbability

Functions

calcDetectionProbability(mag, limmag[, fillFactor, w])

Find the probability of a detection given a visual magnitude,

PPDetectionProbability(eph_df[, trailing_losses, ...])

Find probability of observations being observable for objectInField output.

Module Contents

calcDetectionProbability(mag, limmag, fillFactor=1.0, w=0.1)[source]

Find the probability of a detection given a visual magnitude, limiting magnitude, and fill factor, determined by the fading function from Veres & Chesley (2017).

Parameters:

  • mag (float or array of floats) -- Magnitude of object in filter used for that field.

  • limmag (float or array of floats) -- Limiting magnitude of the field.

  • fillFactor (float), default=1.0) -- Fraction of FOV covered by the camera sensor.

  • w (float, default=0.1) -- Distribution parameter.

Returns:

P -- Probability of detection.

Return type:

float or array of floats

PPDetectionProbability(eph_df, trailing_losses=False, trailing_loss_name='dmagDetect', magnitude_name='PSFMag', limiting_magnitude_name='fiveSigmaDepth_mag', field_id_name='FieldID', fillFactor=1.0, w=0.1)[source]

Find probability of observations being observable for objectInField output. Wrapper for calcDetectionProbability which takes into account column names and trailing losses. Used by PPFadingFunctionFilter.

Parameters:

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

  • trailing_losses (Boolean, default=False) -- Are trailing losses being applied?

  • trailing_loss_name (string, default="dmagDetect") -- eph_df column name for trailing losses

  • magnitude_name (string, default="PSFMag") -- eph_df column name for observation limiting magnitude

  • limiting_magnitude_name (string, default="fiveSigmaDepth_mag") -- eph_df column used for observation limiting magnitude.

  • ID (field) -- eph_df column name for observation field_id

  • fillFactor (float, default=1.0) -- Fraction of FOV covered by the camera sensor.

  • w (float, default=0.1) -- Distribution parameter.

Returns:

Probability of detection.

Return type:

float or array of floats