sorcha.modules.PPFaintObjectCullingFilter

Functions

PPFaintObjectCullingFilter(aux_df, filterpointing, ...)

Performs a first pass over a dataframe of the orbits and physical parameters information

PPEstimatePerihelion(aux_df)

Estimates perihelion for a dataframe of orbital data given in another format.

Module Contents

PPFaintObjectCullingFilter(aux_df, filterpointing, mainfilter, observing_filters, lightcurve_choice, activity_choice)[source]

Performs a first pass over a dataframe of the orbits and physical parameters information to remove any objects that will definitely not be detected.

It estimates the maximum apparent magnitude (at perihelion and max phase) of each object in each filter. If the object is never brighter in any filter than the limiting magnitude + 2 + any brightness added by sorcha-addons, then the object is dropped from the input dataframe.

Parameters:

  • aux_df (Pandas dataframe) -- Dataframe of joined orbits and physical parameters from input files

  • filterpointing (Pandas dataframe) -- Dataframe of input pointing database.

  • mainfilter (str) -- String of filter in which H is supplied.

  • observing_filters (list of str) -- List of observation filters supplied by user.

  • lightcurve_choice (None or str) -- Name of lightcurve model, if using.

  • activity_choice (None or str) -- Name of activity model, if using.

Returns:

aux_df with all objects deemed to be definitely unobservable removed.

Return type:

Pandas dataframe

PPEstimatePerihelion(aux_df)[source]

Estimates perihelion for a dataframe of orbital data given in another format.

Parameters:

aux_df (Pandas dataframe) -- Dataframe of joined orbits and physical parameters from input files

Returns:

q -- Value of q for all rows in aux_df.

Return type:

Pandas series