pept.tracking.Velocity#

class pept.tracking.Velocity(window, degree=2, absolute=False)[source]#

Bases: PointDataFilter

Append the dimension-wise or absolute velocity to samples of points using a 2D fitted polynomial in a rolling window mode.

Filter signature:

PointData -> Velocity.fit_sample -> PointData

If Numba is installed, a fast, natively-compiled algorithm is used.

If absolute = False, the “vx”, “vy” and “vz” columns are appended. If absolute = True, then the “v” column is appended.

__init__(window, degree=2, absolute=False)[source]#

Methods

__init__(window[, degree, absolute])

copy([deep])

Create a deep copy of an instance of this class, including all inner attributes.

fit(point_data[, executor, max_workers, verbose])

Apply self.fit_sample (implemented by subclasses) according to the execution policy.

fit_sample(samples)

load(filepath)

Load a saved / pickled PEPTObject object from filepath.

save(filepath)

Save a PEPTObject instance as a binary pickle object.
fit_sample(samples)[source]#
copy(deep=True)#

Create a deep copy of an instance of this class, including all inner attributes.

fit(point_data, executor='joblib', max_workers=None, verbose=True)#

Apply self.fit_sample (implemented by subclasses) according to the execution policy. Simply return a list of processed samples. If you need a reduction step (e.g. stack all processed samples), apply it in the subclass.

static load(filepath)#

Load a saved / pickled PEPTObject object from filepath.

Most often the full object state was saved using the .save method.

Parameters
filepathfilename or file handle

If filepath is a path (rather than file handle), it is relative to where python is called.

Returns
pept.PEPTObject subclass instance

The loaded object.

Examples

Save a LineData instance, then load it back:

>>> lines = pept.LineData([[1, 2, 3, 4, 5, 6, 7]])
>>> lines.save("lines.pickle")

>>> lines_reloaded = pept.LineData.load("lines.pickle")
save(filepath)#

Save a PEPTObject instance as a binary pickle object.

Saves the full object state, including inner attributes, in a portable binary format. Load back the object using the load method.

Parameters
filepathfilename or file handle

If filepath is a path (rather than file handle), it is relative to where python is called.

Examples

Save a LineData instance, then load it back:

>>> lines = pept.LineData([[1, 2, 3, 4, 5, 6, 7]])
>>> lines.save("lines.pickle")

>>> lines_reloaded = pept.LineData.load("lines.pickle")