sorcha_addons.activity.lsst_comet.lsst_comet_activity

Classes

LSSTCometActivity

Calculating the coma magnitude of a comet with input specifications.

Module Contents

class LSSTCometActivity(required_column_names: List[str] = ['k', 'afrho1', 'optFilter', 'trailedSourceMagTrue'])[source]

Bases: sorcha.activity.base_activity.AbstractCometaryActivity

Calculating the coma magnitude of a comet with input specifications.

The observation dataframe provided to the compute method should have the following columns:

  • k - Dust falling exponential value (dust falling at rh^k)

  • afrho1 - Quantity of A’Hearn et al. (1984). at 1 au (cm). See notes.

  • optFilter - Observing filter of the observation

  • TrailedSourceMag - Apparent magnitude in the input filter of the comet nucleus adding up all of the counts in the trail

Notes: afrho1 - The product of albedo, filling factor of grains within the observer field of view, and the linear radius of the field of view at the comet

This class is derived from lsstcomet by Mike Kelley (C) LSST Solar System Scientific Collaboration 2019

checkPhysical(df: pandas.DataFrame)[source]
compute(df: pandas.DataFrame, observing_filters: List[str], rho: List[float], delta: List[float], alpha: List[float]) → pandas.DataFrame[source]

Returns numpy array of 0’s with shape equal to the input dataframe time column.

Parameters:

  • df (pd.DataFrame) – The observations dataframe provided by Sorcha.

  • observing_filters (List[str]) – The photometric filters the observation is taken in (the filter requested that the coma magnitude be calculated for)

  • rho (List[float]) – Heliocentric distance [units au]

  • delta (List[float]) – Distance to Earth [units au]

  • alpha (List[float]) – Phase angle [units degrees]

Returns:

The original observations dataframe, with updated magnitude values based on results of lsstcomet coma calculations.

Return type:

pd.DataFrame

static name_id() → str[source]

Returns the string identifier for this cometary activity method. It must be unique within all the subclasses of AbstractCometaryActivity.

Returns:

Unique identifier for this cometary activity model

Return type:

str

maxBrightness(df: pandas.DataFrame, observing_filters: List[str], q: List[float], delta: List[float], alpha: List[float])[source]