savu.plugins.filter

class savu.plugins.filter.Filter(name)

Bases: savu.plugins.plugin.Plugin

A Plugin to apply a simple dark and flatfield correction to some raw timeseries data

filter_frame(data)

Should be overloaded by filter classes extending this one

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

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_filter_padding()

Should be overridden to define how wide the frame should be

Returns:a dictionary containing the axis to pad in and the amount

get_max_frames()

Should be overridden to define the max number of frames to process at a time

Returns:an integer of the number of frames

output_data_type()

The output of this plugin is ProjectionData

Returns:Data

process(data, output, processes, process)

required_data_type()

The input for this plugin is RawTimeseriesData

Returns:Data