Skip to content

Commit 0cc92ff

Browse files
amondotvolaya
amondot
authored and
volaya
committed
[processing/otb]update xml and associated html docs
1 parent 5e9647d commit 0cc92ff

File tree

211 files changed

+1732
-8679
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+1732
-8679
lines changed

‎python/plugins/processing/algs/otb/description/BandMathX.xml

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<root>
2+
<key>BandMathX</key>
3+
<exec>otbcli_BandMathX</exec>
4+
<longname>Band Math X</longname>
5+
<group>Miscellaneous</group>
6+
<description>This application performs mathematical operations on multiband images.
7+
Mathematical formula interpretation is done via muParserX library : http://articles.beltoforion.de/article.php?a=muparserx</description>
8+
<parameter>
9+
<parameter_type source_parameter_type="ParameterType_InputImageList">ParameterMultipleInput</parameter_type>
10+
<key>il</key>
11+
<name>Input image list</name>
12+
<description>Image list to perform computation on.</description>
13+
<datatype />
14+
<optional>False</optional>
15+
</parameter>
16+
<parameter>
17+
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
18+
<key>out</key>
19+
<name>Output Image</name>
20+
<description>Output image.</description>
21+
<hidden />
22+
</parameter>
23+
<parameter>
24+
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
25+
<key>ram</key>
26+
<name>Available RAM (Mb)</name>
27+
<description>Available memory for processing (in MB)</description>
28+
<minValue />
29+
<maxValue />
30+
<default>128</default>
31+
</parameter>
32+
<parameter>
33+
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
34+
<key>exp</key>
35+
<name>Expressions</name>
36+
<description>Mathematical expression to apply.</description>
37+
<default />
38+
<multiline />
39+
<optional>True</optional>
40+
</parameter>
41+
<parameter>
42+
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
43+
<key>incontext</key>
44+
<name>Import context</name>
45+
<description>A txt file containing user's constants and expressions.</description>
46+
<isFolder />
47+
<optional>True</optional>
48+
</parameter>
49+
<parameter>
50+
<parameter_type source_parameter_type="ParameterType_OutputFilename">OutputFile</parameter_type>
51+
<key>outcontext</key>
52+
<name>Export context</name>
53+
<description>A txt file where to save user's constants and expressions.</description>
54+
</parameter>
55+
</root>

‎python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-raster.xml

-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
<key>out</key>
1717
<name>Matrix output</name>
1818
<description>Filename to store the output matrix (csv format)</description>
19-
<hidden />
2019
</parameter>
2120
<parameter>
2221
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>

‎python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-vector.xml

-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
<key>out</key>
1717
<name>Matrix output</name>
1818
<description>Filename to store the output matrix (csv format)</description>
19-
<hidden />
2019
</parameter>
2120
<parameter>
2221
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>

‎python/plugins/processing/algs/otb/description/ComputeImagesStatistics.xml

-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,5 @@
2626
<key>out</key>
2727
<name>Output XML file</name>
2828
<description>XML filename where the statistics are saved for future reuse.</description>
29-
<hidden />
3029
</parameter>
3130
</root>

‎python/plugins/processing/algs/otb/description/ComputeOGRLayersFeaturesStatistics.xml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<root>
2+
<key>ComputeOGRLayersFeaturesStatistics</key>
3+
<exec>otbcli_ComputeOGRLayersFeaturesStatistics</exec>
4+
<longname>ComputeOGRLayersFeaturesStatistics</longname>
5+
<group>Segmentation</group>
6+
<description>Compute statistics of the features in a set of OGR Layers</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
9+
<key>inshp</key>
10+
<name>Name of the input shapefile</name>
11+
<description>Name of the input shapefile</description>
12+
<isFolder />
13+
<optional>False</optional>
14+
</parameter>
15+
<parameter>
16+
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
17+
<key>outstats</key>
18+
<name>XML file containing mean and variance of each feature.</name>
19+
<description>XML file containing mean and variance of each feature.</description>
20+
<isFolder />
21+
<optional>False</optional>
22+
</parameter>
23+
<parameter>
24+
<parameter_type source_parameter_type="ParameterType_StringList">ParameterString</parameter_type>
25+
<key>feat</key>
26+
<name>List of features to consider for statistics.</name>
27+
<description>List of features to consider for statistics.</description>
28+
<options />
29+
<default />
30+
</parameter>
31+
</root>

‎python/plugins/processing/algs/otb/description/ComputePolylineFeatureFromImage.xml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<root>
2+
<key>ComputePolylineFeatureFromImage</key>
3+
<exec>otbcli_ComputePolylineFeatureFromImage</exec>
4+
<longname>Compute Polyline Feature From Image</longname>
5+
<group>Feature Extraction</group>
6+
<description>This application compute for each studied polyline, contained in the input VectorData, the choosen descriptors.</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
9+
<key>in</key>
10+
<name>Input Image</name>
11+
<description>An image to compute the descriptors on.</description>
12+
<optional>False</optional>
13+
</parameter>
14+
<parameter>
15+
<parameter_type source_parameter_type="ParameterType_InputVectorData">ParameterVector</parameter_type>
16+
<key>vd</key>
17+
<name>Vector Data</name>
18+
<description>Vector data containing the polylines where the features will be computed.</description>
19+
<shapetype />
20+
<optional>False</optional>
21+
</parameter>
22+
<parameter>
23+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
24+
<key>elev.default</key>
25+
<name>Default elevation</name>
26+
<description>This parameter allows to set the default height above ellipsoid when there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles, and no geoid file has been set. This is also used by some application as an average elevation value.</description>
27+
<minValue />
28+
<maxValue />
29+
<default>0</default>
30+
</parameter>
31+
<parameter>
32+
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
33+
<key>expr</key>
34+
<name>Feature expression</name>
35+
<description>The feature formula (b1 &lt; 0.3) where b1 is the standard name of input image first band</description>
36+
<default />
37+
<multiline />
38+
<optional>False</optional>
39+
</parameter>
40+
<parameter>
41+
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
42+
<key>field</key>
43+
<name>Feature name</name>
44+
<description>The field name corresponding to the feature codename (NONDVI, ROADSA...)</description>
45+
<default />
46+
<multiline />
47+
<optional>False</optional>
48+
</parameter>
49+
<parameter>
50+
<parameter_type source_parameter_type="ParameterType_OutputVectorData">OutputVector</parameter_type>
51+
<key>out</key>
52+
<name>Output Vector Data</name>
53+
<description>The output vector data containing polylines with a new field</description>
54+
<hidden />
55+
</parameter>
56+
</root>

‎python/plugins/processing/algs/otb/description/ConnectedComponentSegmentation.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
5959
<key>elev.default</key>
6060
<name>Default elevation</name>
61-
<description>This parameter allows setting the default height above ellipsoid when there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles, and no geoid file has been set. This is also used by some application as an average elevation value.</description>
61+
<description>This parameter allows to set the default height above ellipsoid when there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles, and no geoid file has been set. This is also used by some application as an average elevation value.</description>
6262
<minValue />
6363
<maxValue />
6464
<default>0</default>

‎python/plugins/processing/algs/otb/description/Convert.xml

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<root>
2+
<key>Convert</key>
3+
<exec>otbcli_Convert</exec>
4+
<longname>Image Conversion</longname>
5+
<group>Image Manipulation</group>
6+
<description>Convert an image to a different format, eventually rescaling the data and/or changing the pixel type.</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
9+
<key>in</key>
10+
<name>Input image</name>
11+
<description>Input image</description>
12+
<optional>False</optional>
13+
</parameter>
14+
<parameter>
15+
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
16+
<key>type</key>
17+
<name>Rescale type</name>
18+
<description>Transfer function for the rescaling</description>
19+
<options>
20+
<choices>
21+
<choice>none</choice>
22+
<choice>linear</choice>
23+
<choice>log2</choice>
24+
</choices>
25+
</options>
26+
<default>0</default>
27+
</parameter>
28+
<parameter>
29+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
30+
<key>type.linear.gamma</key>
31+
<name>Gamma correction factor</name>
32+
<description>Gamma correction factor</description>
33+
<minValue />
34+
<maxValue />
35+
<default>1</default>
36+
</parameter>
37+
<parameter>
38+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
39+
<key>mask</key>
40+
<name>Input mask</name>
41+
<description>The masked pixels won't be used to adapt the dynamic (the mask must have the same dimensions as the input image)</description>
42+
<optional>True</optional>
43+
</parameter>
44+
<parameter>
45+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
46+
<key>hcp.high</key>
47+
<name>High Cut Quantile</name>
48+
<description>Quantiles to cut from histogram high values before computing min/max rescaling (in percent, 2 by default)</description>
49+
<minValue />
50+
<maxValue />
51+
<default>2</default>
52+
</parameter>
53+
<parameter>
54+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
55+
<key>hcp.low</key>
56+
<name>Low Cut Quantile</name>
57+
<description>Quantiles to cut from histogram low values before computing min/max rescaling (in percent, 2 by default)</description>
58+
<minValue />
59+
<maxValue />
60+
<default>2</default>
61+
</parameter>
62+
<parameter>
63+
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
64+
<key>out</key>
65+
<name>Output Image</name>
66+
<description>Output image</description>
67+
<hidden />
68+
</parameter>
69+
<parameter>
70+
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
71+
<key>ram</key>
72+
<name>Available RAM (Mb)</name>
73+
<description>Available memory for processing (in MB)</description>
74+
<minValue />
75+
<maxValue />
76+
<default>128</default>
77+
</parameter>
78+
</root>

‎python/plugins/processing/algs/otb/description/DEMConvert.xml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<root>
2+
<key>DEMConvert</key>
3+
<exec>otbcli_DEMConvert</exec>
4+
<longname>DEM Conversion</longname>
5+
<group>Image Manipulation</group>
6+
<description>Converts a geo-referenced DEM image into a general raster file compatible with OTB DEM handling.</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
9+
<key>in</key>
10+
<name>Input geo-referenced DEM</name>
11+
<description>Input geo-referenced DEM to convert to general raster format.</description>
12+
<optional>False</optional>
13+
</parameter>
14+
<parameter>
15+
<parameter_type source_parameter_type="ParameterType_OutputFilename">OutputFile</parameter_type>
16+
<key>out</key>
17+
<name>Prefix of the output files</name>
18+
<description>will be used to get the prefix (name withtout extensions) of the files to write. Three files - prefix.geom, prefix.omd and prefix.ras - will be generated.</description>
19+
</parameter>
20+
</root>

‎python/plugins/processing/algs/otb/description/Despeckle-frost.xml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<root>
2+
<key>Despeckle-frost</key>
3+
<exec>otbcli_Despeckle</exec>
4+
<longname>Despeckle (frost)</longname>
5+
<group>Image Filtering</group>
6+
<description>Perform speckle noise reduction on SAR image.</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
9+
<key>in</key>
10+
<name>Input Image</name>
11+
<description>Input image.</description>
12+
<optional>False</optional>
13+
</parameter>
14+
<parameter>
15+
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
16+
<key>out</key>
17+
<name>Output Image</name>
18+
<description>Output image.</description>
19+
<hidden />
20+
</parameter>
21+
<parameter>
22+
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
23+
<key>ram</key>
24+
<name>Available RAM (Mb)</name>
25+
<description>Available memory for processing (in MB)</description>
26+
<minValue />
27+
<maxValue />
28+
<default>128</default>
29+
</parameter>
30+
<parameter>
31+
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
32+
<key>filter</key>
33+
<name>speckle filtering method</name>
34+
<description />
35+
<options>
36+
<choices>
37+
<choice>frost</choice>
38+
</choices>
39+
</options>
40+
<default>0</default>
41+
</parameter>
42+
<parameter>
43+
<parameter_type source_parameter_type="ParameterType_Int">ParameterNumber</parameter_type>
44+
<key>filter.frost.rad</key>
45+
<name>Radius</name>
46+
<description>Radius for frost filter</description>
47+
<minValue />
48+
<maxValue />
49+
<default>1</default>
50+
</parameter>
51+
<parameter>
52+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
53+
<key>filter.frost.deramp</key>
54+
<name>deramp</name>
55+
<description>Decrease factor declaration</description>
56+
<minValue />
57+
<maxValue />
58+
<default>0.1</default>
59+
</parameter>
60+
</root>

‎python/plugins/processing/algs/otb/description/Despeckle-lee.xml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<root>
2+
<key>Despeckle-lee</key>
3+
<exec>otbcli_Despeckle</exec>
4+
<longname>Despeckle (lee)</longname>
5+
<group>Image Filtering</group>
6+
<description>Perform speckle noise reduction on SAR image.</description>
7+
<parameter>
8+
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
9+
<key>in</key>
10+
<name>Input Image</name>
11+
<description>Input image.</description>
12+
<optional>False</optional>
13+
</parameter>
14+
<parameter>
15+
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
16+
<key>out</key>
17+
<name>Output Image</name>
18+
<description>Output image.</description>
19+
<hidden />
20+
</parameter>
21+
<parameter>
22+
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
23+
<key>ram</key>
24+
<name>Available RAM (Mb)</name>
25+
<description>Available memory for processing (in MB)</description>
26+
<minValue />
27+
<maxValue />
28+
<default>128</default>
29+
</parameter>
30+
<parameter>
31+
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
32+
<key>filter</key>
33+
<name>speckle filtering method</name>
34+
<description />
35+
<options>
36+
<choices>
37+
<choice>lee</choice>
38+
</choices>
39+
</options>
40+
<default>0</default>
41+
</parameter>
42+
<parameter>
43+
<parameter_type source_parameter_type="ParameterType_Int">ParameterNumber</parameter_type>
44+
<key>filter.lee.rad</key>
45+
<name>Radius</name>
46+
<description>Radius for lee filter</description>
47+
<minValue />
48+
<maxValue />
49+
<default>1</default>
50+
</parameter>
51+
<parameter>
52+
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
53+
<key>filter.lee.nblooks</key>
54+
<name>nb looks</name>
55+
<description>Nb looks for lee filter</description>
56+
<minValue />
57+
<maxValue />
58+
<default>1</default>
59+
</parameter>
60+
</root>

0 commit comments

Comments
 (0)