ndspflow.workflows.Transform

class ndspflow.workflows.Transform(y_array=None, x_array=None)[source]

Transformation class.

Notes

  • If x_array is explicitly defined, func is called as func(x_array, y_array).

  • If func returns two parameters, they are set as (x_array, y_array).

Attributes
y_arrayndarray

Y-axis values. Usually voltage or power.

x_array1d array, optional, default: None

X-axis values. Usually time or frequency.

nodeslist of list

Contains order of operations as: [[function, axis, *args, **kwargs], …]

__init__(y_array=None, x_array=None)[source]

Initalize object.

Methods

__init__([y_array, x_array])

Initalize object.

run_transform(func, *args[, axis])

Execute transformation.

transform(func, *args[, axis])

Queue transformation.

run_transform(func, *args, axis=None, **kwargs)[source]

Execute transformation.

Parameters
funcfunction

Preprocessing function (e.g. filter).

*args

Additonal positional arguments to func.

axisint or tuple of int, optional, default: None

Axis to apply the function along 1d-slices. Only used for 2d and greater. Identical to numpy axis arguments. None assumes transform requires 2d input.

**kwargs

Addional keyword arguments to func.

Notes

This is a slightly more flexible/faster version of np.apply_along_axis that also handles tuples of axes and can be applied to any series of array operations.

transform(func, *args, axis=None, **kwargs)[source]

Queue transformation.

Parameters
funcfunction

Preprocessing function (e.g. filter).

*args

Additonal positional arguments to func.

axisint or tuple of int, optional, default: None
Axis to apply the function along 1d-slices. Only used for 2d and greater.

Identical to numpy axis arguments. None assumes transform requires 2d input.

**kwargs

Addional keyword arguements to func.