adler.science.Colour

Functions

col_obs_ref(planetoid, adler_data[, phase_model, ...])

A function to calculate the colour of an Adler planetoid object.

Module Contents

col_obs_ref(planetoid, adler_data, phase_model='HG12_Pen16', filt_obs='g', filt_ref='r', N_ref=3, x_col='midPointMjdTai', y_col='AbsMag', yerr_col='magErr', obsId_col='diaSourceId', x1=None, x2=None, plot_dir=None, plot_show=False)[source]

A function to calculate the colour of an Adler planetoid object. An observation in a given filter (filt_obs) is compared to previous observation in a reference filter (filt_ref). By setting N_ref one can control how many reference observations to include in the colour calculation. Note that the observations are considered to be in reduced magnitudes, hence why an adlerData object with phase curve models is passed.

Parameters:

  • planetoid (object) – Adler planetoid object

  • adler_data (object) – AdlerData object

  • phase_model (str) – Name of phase curve model to use for calculating colour

  • filt_obs (str) – Filter name of the new observation for which to calculate a filt_obs - filt_ref colour

  • filt_ref (str) – Filter name of the reference observations when calculating the filt_obs - filt_ref colour

  • N_ref (int) – Number of reference observations to use when calculated the reference absolute magnitude. Set to 1 to use only the most recent of ref observations. Set to None to use all past ref obs.

  • x_col (str) – Time (or phase angle) column name

  • y_col (str) – Magnitude column name (e.g. AbsMag or reduced_mag)

  • yerr_col (str) – Magnitude uncertainty column name

  • obsId_col (str) – Column name for the unique observation identifier

  • x1 (float) – Lower limit on x_col values (>=)

  • x2 (float) – Upper limit on x_col values (<=)

  • plot_dir (str) – Directory in which to save the colour plot

Returns:

col_dict – Dictionary containing the colour information for the most recent obs in filt_obs

Return type:

dict