sorcha.lightcurves.identity_lightcurve

Classes

!!! THIS SHOULD NEVER BE USED - FOR TESTING ONLY !!!

class IdentityLightCurve(required_column_names: List[str] = ['fieldMJD_TAI'])[source]

!!! THIS SHOULD NEVER BE USED - FOR TESTING ONLY !!!

Rudimentary lightcurve model that returns no shift. This class is explicitly created for testing purposes.

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

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

Parameters:: df (Pandas dataframe) -- The observations dataframe provided by Sorcha.
Returns:: Numpy array of 0's with shape equal to the input dataframe time column.
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.

We have chosen the name "identity" here because the input brightness will equal the output brightness if this model is applied.