sorcha.activity.identity_activity

Classes

IdentityCometaryActivity

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

Module Contents

class IdentityCometaryActivity[source]

Bases: sorcha.activity.base_activity.AbstractCometaryActivity

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

Rudimentary cometary activity model that returns no change to the input observation dataframe. This class is explicitly created for testing purposes.

compute(df: pandas.DataFrame) → 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.
Returns:: The original observations dataframe, unchanged.
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.

We have chosen the name "identity" here because the input dataframe is returned unchanged.

Returns:: Unique identifier for this cometary activity model
Return type:: str