Test Setup Failed
Push — master ( 614633...164ec0 )
by Nicola
03:53 queued 17s
created

PluginTemplate4Tools.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 PluginTemplate4Tools(PluginTools):
4
    """
5
    A template for a plugin that takes in two datasets and returns one dataset,
6
    e.g. absorption correction.
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
        in_datasets:
17
            visibility: datasets
18
            dtype: [list[str],list[]]
19
            description: Override the in_datasets parameter
20
            default: ['fluo', 'stxm']
21
        preview:
22
            visibility: basic
23
            dtype: preview
24
            description: Reduce the number of sinograms of stxm to match fluo
25
            default: []
26
        out_datasets:
27
            visibility: datasets
28
            dtype: [list[str],list[]]
29
            description: Override the out_datasets parameter
30
            default: ['fluo']
31
32
        """