examples.plugin_examples.plugin_templates.general.plugin_template6_tools

Complexity

Total Complexity

1

Size/Duplication

Total Lines	11
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	PluginTemplate6Tools.define_parameters()	0	2	1

from savu.plugins.plugin_tools import PluginTools

class PluginTemplate6Tools(PluginTools):
    """
    A template to create a plugin that changes the shape of the data,
    e.g. downsample_filter.
    """

    def define_parameters(self):
        """
        example:
            visibility: basic
            dtype: [None, str]
            description: Example of a plugin parameter
            default: None
        bin_size:
            visibility: basic
            dtype: int
            description: Bin size for the downsample
            default: 2
        pattern:
            visibility: basic
            dtype: str
            description: The pattern the plugin should be applied to
            default: 'PROJECTION'
        """