sorcha.lightcurves.base_lightcurve

Attributes

logger

Classes

AbstractLightCurve

Abstract base class for lightcurve models

Module Contents

logger[source]
class AbstractLightCurve(required_column_names: List[str] = [])[source]

Bases: abc.ABC

Abstract base class for lightcurve models

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

User implemented calculation based on the input provided by the pandas dataframe df.

Parameters:

df (Pandas dataframe) -- The observations dataframe provided by Sorcha.

_validate_column_names(df: pandas.DataFrame) → None[source]
Private method that checks that the provided pandas dataframe contains

the required columns defined in self.required_column_names.

Parameters:

df (Pandas dataframe) -- The observations dataframe provided by Sorcha.

_log_exception(exception: Exception) → None[source]

Log an error message from an exception to the error log file

Parameters:

exception (Exception) -- The exception with a string to appended to the error log

_log_error_message(error_msg: str) → None[source]

Log a specific error string to the error log file

Parameters:

error_msg (string) -- The string to be appended to the error log

static name_id() → str[source]
Abstractmethod:

This method will return the unique name of the LightCurve Model