sorcha_addons.lightcurve.sinusoidal.sinusoidal_lightcurve

Classes

SinusoidalLightCurve

Assumes a sinusoidal lightcurve in magnitude space with a given period and lightcurve amplitude.

Module Contents

class SinusoidalLightCurve(required_column_names: List[str] = ['fieldMJD_TAI', 'LCA', 'Period', 'Time0'])[source]

Bases: sorcha.lightcurves.base_lightcurve.AbstractLightCurve

Assumes a sinusoidal lightcurve in magnitude space with a given period and lightcurve amplitude. The observation dataframe provided to the compute method should have the following columns:

  • FieldMJD_TAI - time of observation.

  • LCA - lightcurve amplitude [magnitudes].

  • Period - period of the sinusoidal oscillation [days]. Should be a positive value.

  • Time0 - phase for the light curve [days].

compute(df: pandas.DataFrame) → numpy.array[source]

Computes a sinusoidal light curve given the input dataframe

Parameters:

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

Returns:

Numpy array of with shape equal to the input dataframe “FieldMJD” column. Values are changes to the magnitude.

Return type:

np.array

static name_id() → str[source]

Returns the string identifier for this light curve method. It must be unique within all the subclasses of AbstractLightCurve.

Returns:

Unique identifier for this light curve calculator

Return type:

str

maxBrightness(df: pandas.DataFrame) → float[source]