savu.plugins.plugin

class savu.plugins.plugin.Plugin(name='Plugin')

Bases: object

The base class from which all plugins should inherit.

get_citation_inforamtion()

Gets the Citation Information for a plugin

Returns:A populated savu.data.process_data.CitationInfomration

output_data_type()

Gets the output data type which is provided by the plugin

Returns:the class of the data which will be provided

populate_default_parameters()

This method should populate all the required parameters with default values. it is used for checking to see if new parameter values are appropriate

It makes use of the classes including parameter information in the class docstring such as this :param error_threshold: Convergence threshold. Default: 0.001.

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

required_data_type()

Gets the input data type which is required for the plugin

Returns:the class of the data which is expectd

set_parameters(parameters)

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

Parameters:parameters (dict) – A dictionary of the parameters for this plugin, or None if no customisation is required