Test Failed
Pull Request — master (#916)
by Daniil
05:04
created

MinAndMaxTools.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 MinAndMaxDeprecatedTools(PluginTools):
4
    """A plugin to calculate the min and max values of each slice (as determined
5
by the pattern parameter)
6
    """
7
    def define_parameters(self):
8
        """
9
        method:
10
           visibility: basic
11
           dtype: str
12
           options: ['extrema', 'percentile']
13
           description: Method to find the global min and the global max.
14
           default: percentile
15
16
        p_range:
17
            visibility: basic
18
            dtype: list[float,float]
19
            description: Percentage range if use the 'percentile' method.
20
            default: [0.0, 100.0]
21
22
        pattern:
23
            visibility: basic
24
            dtype: str
25
            description: How to slice the data.
26
            default: VOLUME_XZ
27
28
        smoothing:
29
            visibility: intermediate
30
            dtype: bool
31
            description: Apply a smoothing filter or not.
32
            default: True
33
34
        masking:
35
            visibility: intermediate
36
            dtype: bool
37
            description: Apply a circular mask or not.
38
            default: True
39
40
        ratio:
41
            visibility: intermediate
42
            dtype: [None,float]
43
            description: Used to calculate the circular mask. If not provided,
44
              it is calculated using the center of rotation.
45
            default: None
46
47
        out_datasets:
48
             visibility: datasets
49
             dtype: [list[],list[str]]
50
             description: The default names.
51
             default: ['the_min','the_max']
52
        """
53