savu.data.plugin_list module¶
-
class
CitationInformation(description, bibtex='', endnote='', doi='', short_name_article='', dependency='')[source] Descriptor of Citation Information for plugins
-
seperate_bibtex(start_char, end_char, author=False)[source] Return the string contained between provided characters
- Parameters
start_char – Character to split the string at
end_char – Character to end the split at
- Returns
The string contained between both characters
-
seperate_endnote(seperation_char)[source] Return the string contained between start characters and a new line
- Parameters
seperation_char – Character to split the string at
- Returns
The string contained between start characters and a new line
-
write(citation_group)[source]
-
-
class
PluginList[source] The PluginList class handles the plugin list - loading, saving and adding citation information for the plugin
-
add_iterate_plugin_group(start, end, iterations)[source] Add an element to self.iterate_plugin_groups
-
add_template(create=False)[source]
-
check_pos_in_iterative_loop(pos)[source] Check if the given plugin position is in an iterative loop
-
clear_iterate_plugin_group_dicts()[source] Reset the list of dicts representing groups of plugins to iterate over
-
get_iterate_plugin_group_dicts()[source] Return the list of dicts representing groups of plugins to iterate over
-
print_iterative_loops()[source]
-
remove_associated_iterate_group_dict(pos, direction)[source] Remove an iterative loop associated to a plugin index
-
remove_iterate_plugin_groups(indices)[source] Remove elements from self.iterate_plugin_groups
-
shift_iterative_loop(iterate_group, direction)[source] Shift an iterative loop up or down in the process list, based on if a plugin is added or removed
-
shift_range_iterative_loops(positions, direction)[source] Shift all iterative loops within a range of plugin indices
-
shift_subsequent_iterative_loops(pos, direction)[source] Shift all iterative loops occurring after a given plugin position
-