sorcha.modules.PPApplyFOVFilter

Functions

PPApplyFOVFilter(observations, sconfigs, module_rngs)

Wrapper function for PPFootprintFilter and PPFilterDetectionEfficiency that checks to see

PPGetSeparation(obj_RA, obj_Dec, cen_RA, cen_Dec)

Function to calculate the distance of an object from the field centre.

PPCircleFootprint(observations, circle_radius)

Simple function which removes objects which lay outside of a circle

PPSimpleSensorArea(ephemsdf, module_rngs[, fillfactor])

Randomly removes a number of observations proportional to the

Module Contents

PPApplyFOVFilter(observations, sconfigs, module_rngs, visits=None, footprint=None, verbose=False)[source]

Wrapper function for PPFootprintFilter and PPFilterDetectionEfficiency that checks to see whether a camera footprint filter should be applied or if a simple fraction of the circular footprint should be used, then applies the required filter where rows are

are removed from the inputted pandas dataframevfor moving objects that land outside of their associated observation's footprint.

Adds the following columns to the observations dataframe:

  • detectorId (if full camera footprint is used)

Parameters:

  • observations (Pandas dataframe)

  • observations. (dataframe of)

  • sconfigs (dataclass) -- Dataclass of configuration file arguments.

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

  • footprint (Footprint, default=None) -- A Footprint class object that represents the boundaries of the detector(s).

  • verbose (boolean, default=False) -- Controls whether logging in verbose mode is on or off.

Returns:

observations -- dataframe of observations updated after field-of-view filters have been applied.

Return type:

Pandas dataframe

PPGetSeparation(obj_RA, obj_Dec, cen_RA, cen_Dec)[source]

Function to calculate the distance of an object from the field centre.

Parameters:

  • obj_RA (float) -- RA of object in decimal degrees.

  • obj_Dec (float) -- Dec of object in decimal degrees.

  • cen_RA (float) -- RA of field centre in decimal degrees.

  • cen_Dec (float) -- Dec of field centre in decimal degrees.

Returns:

sep_degree -- The separation of the object from the centre of the field, in decimal degrees.

Return type:

float

PPCircleFootprint(observations, circle_radius)[source]

Simple function which removes objects which lay outside of a circle of given radius centred on the field centre.

Parameters:

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

  • circle_radius (float) -- radius of circle footprint in degrees.

Returns:

new_observations -- dataframe of observations with all lying beyond the circle radius dropped.

Return type:

Pandas dataframe

PPSimpleSensorArea(ephemsdf, module_rngs, fillfactor=0.9)[source]

Randomly removes a number of observations proportional to the fraction of the field not covered by the detector.

Parameters:

  • ephemsdf (Pandas dataframe) -- Dataframe containing observations.

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

  • fillfactor (float, default=0.9) -- fraction of FOV covered by the sensor.

Returns:

ephemsOut -- Dataframe of observations with 1- fillfactor fraction of objects removed per on-sky observation pointing.

Return type:

Pandas dataframe