Step#

class pypillometry.Step(method, args=(), kwargs=None, namespace=None)[source]#

Bases: object

A pipeline step: a deferred call of a transforming method.

Made by pp.pupil.<method>(...), pp.gaze.<method>(...) or the generic steps (pp.crop(...), …), not directly. Apply it with d | step, which returns a processed copy of d; combine steps with step1 | step2 into a Pipeline.

The arguments are checked against the method’s signature when the step is made. Steps do not accept inplace (a pipeline works on a copy).

Parameters:

  • method (callable) – the method (decorated with step())

  • args (tuple) – positional arguments for the method

  • kwargs (dict) – keyword arguments for the method

  • namespace (str or None) – name of the namespace of the method (e.g., "pupil"), or None for a method of the data object itself

Details

property qualname#

Name of the step as called, e.g. pp.pupil.blinks_detect.