sorcha.modules.PPCalculateApparentMagnitudeInFilter

Functions

PPCalculateApparentMagnitudeInFilter(padain, function, ...)

The trailed source apparent magnitude is calculated in the filter for given H,

Module Contents

PPCalculateApparentMagnitudeInFilter(padain, function, observing_filters, colname='trailedSourceMagTrue', lightcurve_choice=None, cometary_activity_choice=None)[source]

The trailed source apparent magnitude is calculated in the filter for given H, phase function, light curve, and cometary activity parameters.

Adds the following columns to the observations dataframe:

  • trailedSourceMagTrue

  • any columns created by the optional light curve and cometary activity models

Notes

PPApplyColourOffsets should be run beforehand to apply any needed colour offset to H and ensure correct variables are present.

The phase function model options utlized are the sbpy package's implementation:

  • HG: Bowell et al. (1989) Asteroids II book.

  • HG1G2: Muinonen et al. (2010) Icarus 209 542.

  • HG12: Penttilä et al. (2016) PSS 123 117.

  • linear: (as implemented in sbpy)

  • none : No model is applied

Parameters:

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

  • function (string) -- Desired phase function model. Options are "HG", "HG12", "HG1G2", "linear", "none".

  • colname (string) -- Column name in which to store calculated magnitude to the padain dataframe. Default = "TrailedSourceMag"

  • lightcurve_choice (stringm optional) -- Choice of light curve model. Default = None

  • cometary_activity_choice (string, optional) -- Choice of cometary activity model. Default = None

Returns:

padain -- Dataframe of observations (padain) modified with calculated trailed source apparent magnitude column and any optional cometary actvity or light curve added columns based on the models used.

Return type:

Pandas dataframe