savu.core.iterate_plugin_group_utils module¶
-
check_if_end_plugin_in_iterate_group
(exp)[source] Determines if the current plugin is at the end of an iterative loop
-
check_if_in_iterative_loop
(exp)[source] Inspect the metadata inside the Experiment object to determine if current processing is inside an iterative loop
-
create_clone
(clone, data)[source] Create a clone of a Data object
-
enable_iterative_loop
(setup_fn)[source] Decorator that can be applied to a plugin’s setup() method. Doing so modifies the plugin’s setup slightly to work correctly when at the end of an iterative loop, by setting up the relevant extra output dataset.
-
setup_extra_plugin_data_padding
(padding_fn)[source] Decorator that can be applied to a filter plugin’s set_filter_padding() method. Doing so modifies/extends the filter plugin’s padding function slightly to also set the padding for the additional PluginData objects that are created when an iterative loop is defined.
-
shift_plugin_index
(exp, index)[source] The indices used for plugins when editing a process list in the configurator, and the indices used by PluginRunner._run_plugin_list(), differ based on a few different things, such as: - zero-based indexing internally in Savu, but one-based indexing in the
configurator
the number of loaders in the process list
This function is for shifting the one-based plugin index as would be seen in the configurator, to the nPlugin experimental metadata value as would be seen for the same plugin in the for loop in PluginRunner._run_plugin_list().