Pipelines

Processing steps are combined with |:

d = d | (pp.pupil.blinks_detect() | pp.pupil.lowpass_filter(5) | pp.downsample(50))

d | step returns a processed copy of d. Steps combine into a Pipeline, a value that can be applied to several datasets and copies the data only once (d | a | b copies at each |); see Pipelines and history.

Steps for pupil and gaze data

pp.pupil.<method>(...) and pp.gaze.<method>(...) make steps from the methods of d.pupil and d.gaze, with the same arguments (see PupilNamespace and GazeNamespace).

Generic steps

Each of these makes a step from the method of the same name (e.g., pp.crop(...) calls EyeData.crop()).

crop	Pipeline step for crop() (d | pp.crop(...)).
downsample	Pipeline step for downsample() (d | pp.downsample(...)).
scale	Pipeline step for scale() (d | pp.scale(...)).
unscale	Pipeline step for unscale() (d | pp.unscale(...)).
merge_eyes	Pipeline step for merge_eyes() (d | pp.merge_eyes(...)).
reset_time	Pipeline step for reset_time() (d | pp.reset_time(...)).
mask_intervals	Pipeline step for mask_intervals() (d | pp.mask_intervals(...)).
interpolate_intervals	Pipeline step for interpolate_intervals() (d | pp.interpolate_intervals(...)).
exclude_intervals	Pipeline step for exclude_intervals() (d | pp.exclude_intervals(...)).
keep_intervals	Pipeline step for keep_intervals() (d | pp.keep_intervals(...)).
remove_intervals	Pipeline step for remove_intervals() (d | pp.remove_intervals(...)).
merge_masks	Pipeline step for merge_masks() (d | pp.merge_masks(...)).
clear_layer	Pipeline step for clear_layer() (d | pp.clear_layer(...)).
set_blinks	Pipeline step for set_blinks() (d | pp.set_blinks(...)).
set_events	Pipeline step for set_events() (d | pp.set_events(...)).
add_events	Pipeline step for add_events() (d | pp.add_events(...)).
set_experimental_setup	Pipeline step for set_experimental_setup() (d | pp.set_experimental_setup(...)).
drop_data	Pipeline step for drop_data() (d | pp.drop_data(...)).
drop_original	Pipeline step for drop_original() (d | pp.drop_original(...)).
fill_time_discontinuities	Pipeline step for fill_time_discontinuities() (d | pp.fill_time_discontinuities(...)).

Steps and pipelines

Step	A pipeline step: a deferred call of a transforming method.
Pipeline	A sequence of pipeline steps, applied with d | pipeline.