rfwtools.example.IExample

class rfwtools.example.IExample(data_dir=None)

Bases: object

Abstract class that defines the basic interface for an Example.

This only defines methods and properties related to data access.

__init__(data_dir=None)

Construct an instance of the Example class.

Methods

__init__([data_dir])	Construct an instance of the Example class.
get_example_type()	Get this Example's ExampleType.
load_data()	This method should do everything necessary to create an example_df DataFrame at a minimum.
unload_data()	This method should do everything necessary to free up memory used in load_data.

Attributes

event_df	The DataFrame for holding the actual waveform data
data_dir	The directory where the waveform data can be found.
e_type	The type of example this is.

data_dir

The directory where the waveform data can be found. None if Config is to be referenced.

Type:

(str)

e_type

The type of example this is.

Type:

(ExampleType)

event_df

The DataFrame for holding the actual waveform data

Type:

(pd.DataFrame)

get_example_type()

Get this Example’s ExampleType.

Return type:

ExampleType

Returns:

The Enum corresponding to the class type

load_data()

This method should do everything necessary to create an example_df DataFrame at a minimum.

Subclasses should use this method as the interface for loading all data associated with the fault event.

Return type:

None

unload_data()

This method should do everything necessary to free up memory used in load_data.

Return type:

None