]> Creatis software - CreaPhase.git/blob - boutiquesDesc/1D_creaPhase.json
added boutiques descriptors
[CreaPhase.git] / boutiquesDesc / 1D_creaPhase.json
1 {\r
2     "name": "CreaPhase1D", \r
3         "container-image": {\r
4                 "type": "docker",\r
5                 "image": "camarasu/creaphase:0.3"\r
6         },\r
7     "tool-version": "v0.3",   \r
8         "schema-version": "0.5", \r
9     "author": "Loriane Weber, Simon Rit, Jean Michel Létang, Françoise Peyrin, Max Langer", \r
10     "command-line": "MYDIR=$PWD; cd /CreaPhase; mkdir [DIROUT]; octave --silent --eval \"SimuPBI_unknown_1D_func('[BASENAME]', [OVERSAMP],  [[DIST]], [ENERGY], [PIXELSIZE], [NBPROJ], [RANGEANGLE], [MODELCTF], [MODELFRESNEL], [ATTFILE], [PHFILE], '[DIROUT]', '[NOISETYPE]', [NOISEAMOUNT])\";  tar czf $MYDIR/[RESULTS] [DIROUT]", \r
11     "description": "x-ray phase-contrast simulator", \r
12     "error-codes": [\r
13         {\r
14             "code": 1, \r
15             "description": "Crashed"\r
16         }\r
17     ], \r
18     "inputs": [\r
19                 {\r
20             "id": "oversamp", \r
21             "name": "Oversampling of the projections : use 2 or 4", \r
22             "optional": false, \r
23             "type": "String", \r
24                         "command-line-flag": "",\r
25                         "command-line-flag-separator": "",\r
26             "value-key": "[OVERSAMP]"\r
27         }, \r
28         {\r
29             "id": "basename", \r
30             "name": "Basename of the result files", \r
31             "optional": false, \r
32             "type": "String", \r
33                         "command-line-flag": "",\r
34                         "command-line-flag-separator": "",\r
35             "value-key": "[BASENAME]"\r
36         }, \r
37         {\r
38             "id": "dist", \r
39             "name": "Distances of propagation (in m), e.g. 0 0.01 0.1 0.20 0.50", \r
40             "optional": false, \r
41             "type": "String", \r
42                         "command-line-flag": "",\r
43                         "command-line-flag-separator": "",\r
44             "value-key": "[DIST]"\r
45         }, \r
46         {\r
47             "id": "energy", \r
48             "name": "Energy of the incoming X-ray beam (in keV)", \r
49             "optional": false, \r
50             "type": "String", \r
51                         "command-line-flag": "",\r
52                         "command-line-flag-separator": "",\r
53             "value-key": "[ENERGY]"\r
54         }, \r
55         {\r
56             "id": "pixelSize", \r
57             "name": "Pixel size of the detector (in um)", \r
58             "optional": false, \r
59             "type": "String", \r
60                         "command-line-flag": "",\r
61             "value-key": "[PIXELSIZE]"\r
62         },\r
63                         {\r
64             "id": "nbProj", \r
65             "name": "Number of projections (e.g., 360)", \r
66             "optional": false, \r
67             "type": "String", \r
68                         "command-line-flag": "",\r
69                         "command-line-flag-separator": "",\r
70             "value-key": "[NBPROJ]"\r
71         },\r
72         {\r
73             "id": "rangeAngle", \r
74             "name": "Range of the tomography : 180 or 360 degrees", \r
75             "optional": false, \r
76             "type": "String", \r
77                         "command-line-flag": "",\r
78             "value-key": "[RANGEANGLE]"\r
79         },\r
80                 {\r
81             "id": "modelCtf", \r
82             "name": "Use 1 if you want to use the CTF model, 0 otherwise", \r
83             "optional": false, \r
84             "type": "String", \r
85                         "command-line-flag": "",\r
86                         "command-line-flag-separator": "",\r
87             "value-key": "[MODELCTF]"\r
88         }, \r
89         {\r
90             "id": "modelFresnel", \r
91             "name": "Use 1 if you want to use the Fresnel model, 0 otherwise", \r
92             "optional": false, \r
93             "type": "String", \r
94                         "command-line-flag": "",\r
95                         "command-line-flag-separator": "",\r
96             "value-key": "[MODELFRESNEL]"\r
97         }, \r
98         {\r
99             "id": "attfile", \r
100             "name": "Attenuation map file (in cm^-1)", \r
101             "optional": false, \r
102             "type": "File", \r
103                         "command-line-flag": "",\r
104                         "command-line-flag-separator": "",\r
105             "value-key": "[ATTFILE]"\r
106         }, \r
107         {\r
108             "id": "PHFILE", \r
109             "name": "Refrcative index decrement map (delta)", \r
110             "optional": false, \r
111             "type": "File", \r
112                         "command-line-flag": "",\r
113                         "command-line-flag-separator": "",\r
114             "value-key": "[PHFILE]"\r
115         }, \r
116         {\r
117             "id": "dirOut", \r
118             "name": "Output directory name", \r
119             "optional": false, \r
120             "type": "String", \r
121                         "command-line-flag": "",\r
122                         "command-line-flag-separator": "",\r
123             "value-key": "[DIROUT]"\r
124         }, \r
125         {\r
126             "id": "noiseType", \r
127             "name": "Use noise='gaussian' (addition of gaussian noise) or noise='poisson' (generation of Poisson noise).", \r
128             "optional": false, \r
129             "type": "String", \r
130                         "command-line-flag": "",\r
131                         "command-line-flag-separator": "",\r
132             "value-key": "[NOISETYPE]"\r
133         }, \r
134         {\r
135             "id": "noiseAmount", \r
136             "name": "If 'gaussian' (additive noise), please specify the Peak-to-peak Signe-to-noise ratio (PPSNR, in dB). If 'poisson', please specify a scaling factor ranging in [0:1].", \r
137             "optional": false, \r
138             "type": "String", \r
139                         "command-line-flag": "",\r
140             "value-key": "[NOISEAMOUNT]"\r
141         }\r
142     ], \r
143         "output-files":[\r
144                 {\r
145                         "id" : "resultTarball",\r
146                         "name" : "resultTarball",\r
147                         "description" : "archive of the output folder containing execution results, and the output of the command",\r
148                         "path-template" : "results.tar.gz",\r
149                         "optional": false, \r
150                         "value-key" : "[RESULTS]"\r
151                 }\r
152         ]\r
153 }