savu.plugins.utils

savu.plugins.utils.create_output_data(plugin, input_data, file_name, group_name, mpi=False)

Creates an output file of the appopriate type for a specified plugin

Parameters:
  • plugin (savu.plugins.Plugin) – The plugin for which the data is being created.
  • input_data (savu.structure.Data) – The data which is being passed to the plugin
  • file_name (path) – The file name of the new output file
  • group_name (str) – the group name which all the data will be put into
  • mpi (bool) – Whether this is running in the MPI enviroment
Returns:

The output data object

savu.plugins.utils.find_args(dclass)

Finds the parameters list from the docstring

savu.plugins.utils.get_projection_data(input_data, file_name, group_name, mpi=False)

Gets a file backed, Raw data object

Returns:a RawTimeseriesData Object containing the example data.
savu.plugins.utils.get_raw_data(input_data, file_name, group_name, mpi=False)

Gets a file backed, Raw data object

Returns:a RawTimeseriesData Object containing the example data.
savu.plugins.utils.get_volume_data(input_data, file_name, group_name, mpi=False)

Gets a file backed, Raw data object

Returns:a RawTimeseriesData Object containing the example data.
savu.plugins.utils.load_plugin(plugin_name)

Load a plugin.

Parameters:plugin_name (str.) – Name of the plugin to import /path/loc/then.plugin.name if there is no path, then the assumptiuon is an internal plugin
Returns:An instance of the class described by the named plugin
savu.plugins.utils.load_raw_data(filename)
savu.plugins.utils.module2class(module_name)

Converts a module name to a class name

Parameters:module_name (str) – The lowercase_module_name of the module
Returns:the module name in CamelCase

Previous topic

savu.plugins

Next topic

savu.plugins.plugin

This Page