savu.plugins.pass_through_plugin¶

class savu.plugins.pass_through_plugin.PassThroughPlugin(name='PassThroughPlugin')¶

The base class from which all plugins should inherit.

get_filter_frame_type()¶

get_filter_frame_type tells the pass through plugin which direction to slice through the data before passing it on

returns: the savu.structure core_direction describing the frames to filter

get_max_frames()¶

get_max_frames tells the pass through plugin how many frames to give to the plugins process method at a time, the default is a stack of 8

returns: The number of frames to process per call to process (8)

output_data_type()¶

The output of this plugin is Data

Returns:	Data

process(data, output, processes, process)¶

This method is called after the plugin has been created by the pipeline framework

Parameters:	data (savu.data.structures) – The input data object. data – The output data object processes – The number of processes which will be doing the work path (int) – The specific process which we are

process_frame(data)¶

Should be overloaded by filter classes extending this one

Parameters:	data (ndarray) – The data to filter
Returns:	The filtered image

required_data_type()¶

The input for this plugin is Data

Returns:	Data