Base Filter Template

class doc_octopy.datasets.filters._template.EMGAugmentation(input_is_chunked=None, is_output=False)[source]

Bases: FilterBaseClass

Base class for EMG augmentation_pipelines.

Parameters:

  • input_is_chunked (bool)

  • is_output (bool)

class doc_octopy.datasets.filters._template.FilterBaseClass(input_is_chunked=None, allowed_input_type=None, is_output=False, name=None)[source]

Bases: object

Base class for filters.

Parameters:

  • input_is_chunked (bool) – Whether the input is chunked or not.

  • allowed_input_type (Literal["both", "chunked", "not chunked"]) – Whether the filter accepts chunked input, not chunked input or both.

  • is_output (bool) – Whether the filter is an output filter. If True, the resulting signal will be outputted by and dataset pipeline.

  • name (str)

__call__(input_array: np.ndarray) → np.ndarray[source]

Filters the input array. Input shape is determined by whether the allowed_input_type is “both”, “chunked” or “not chunked”.