pept.tracking.Swap#

class pept.tracking.Swap(*swaps, inplace=True)[source]#

Bases: Filter

Swap two columns in a LineData or PointData.

Filter signature:

 LineData -> Swap.fit_sample -> LineData
PointData -> Swap.fit_sample -> PointData

For example, swap the Y and Z axes: Swap("y, z").fit_sample(points). Add multiple swaps as separate arguments: Swap("y, z", "label, x").

You can also swap columns at numerical indices by single-quoting them: Swap("'0', '1'").

New in pept-0.4.3

__init__(*swaps, inplace=True)[source]#

Methods

__init__(*swaps[, inplace])

copy([deep])

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

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

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

fit_sample(sample)

load(filepath)

Load a saved / pickled PEPTObject object from filepath.

save(filepath)

Save a PEPTObject instance as a binary pickle object.

Attributes

swaps

property swaps#
fit_sample(sample: IterableSamples)[source]#
copy(deep=True)#

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

fit(samples, 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")