Test Failed
Pull Request — master (#797)
by
unknown
03:47
created

PluginTemplate6Tools.define_parameters()   A

Complexity

Conditions 1

Size

Total Lines 2
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 1
nop 1
dl 0
loc 2
rs 10
c 0
b 0
f 0
1
from savu.plugins.plugin_tools import PluginTools
2
3
class PluginTemplate6Tools(PluginTools):
4
    """
5
    A template to create a plugin that changes the shape of the data,
6
    e.g. downsample_filter.
7
    """
8
9
    def define_parameters(self):
10
        """
11
        example:
12
            visibility: basic
13
            dtype: [None, str]
14
            description: Example of a plugin parameter
15
            default: None
16
        bin_size:
17
            visibility: basic
18
            dtype: int
19
            description: Bin size for the downsample
20
            default: 2
21
        pattern:
22
            visibility: basic
23
            dtype: str
24
            description: The pattern the plugin should be applied to
25
            default: ['PROJECTION']
26
        """