Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
[processing/otb]update xml and associated html docs
  • Loading branch information
amondot authored and volaya committed Nov 4, 2015
1 parent 5e9647d commit 0cc92ff
Show file tree
Hide file tree
Showing 211 changed files with 1,732 additions and 8,679 deletions.
55 changes: 55 additions & 0 deletions python/plugins/processing/algs/otb/description/BandMathX.xml
@@ -0,0 +1,55 @@
<root>
<key>BandMathX</key>
<exec>otbcli_BandMathX</exec>
<longname>Band Math X</longname>
<group>Miscellaneous</group>
<description>This application performs mathematical operations on multiband images.
Mathematical formula interpretation is done via muParserX library : http://articles.beltoforion.de/article.php?a=muparserx</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImageList">ParameterMultipleInput</parameter_type>
<key>il</key>
<name>Input image list</name>
<description>Image list to perform computation on.</description>
<datatype />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
<key>out</key>
<name>Output Image</name>
<description>Output image.</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
<key>ram</key>
<name>Available RAM (Mb)</name>
<description>Available memory for processing (in MB)</description>
<minValue />
<maxValue />
<default>128</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
<key>exp</key>
<name>Expressions</name>
<description>Mathematical expression to apply.</description>
<default />
<multiline />
<optional>True</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
<key>incontext</key>
<name>Import context</name>
<description>A txt file containing user's constants and expressions.</description>
<isFolder />
<optional>True</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputFilename">OutputFile</parameter_type>
<key>outcontext</key>
<name>Export context</name>
<description>A txt file where to save user's constants and expressions.</description>
</parameter>
</root>
Expand Up @@ -16,7 +16,6 @@
<key>out</key>
<name>Matrix output</name>
<description>Filename to store the output matrix (csv format)</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
Expand Down
Expand Up @@ -16,7 +16,6 @@
<key>out</key>
<name>Matrix output</name>
<description>Filename to store the output matrix (csv format)</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
Expand Down
Expand Up @@ -26,6 +26,5 @@
<key>out</key>
<name>Output XML file</name>
<description>XML filename where the statistics are saved for future reuse.</description>
<hidden />
</parameter>
</root>
@@ -0,0 +1,31 @@
<root>
<key>ComputeOGRLayersFeaturesStatistics</key>
<exec>otbcli_ComputeOGRLayersFeaturesStatistics</exec>
<longname>ComputeOGRLayersFeaturesStatistics</longname>
<group>Segmentation</group>
<description>Compute statistics of the features in a set of OGR Layers</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
<key>inshp</key>
<name>Name of the input shapefile</name>
<description>Name of the input shapefile</description>
<isFolder />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputFilename">ParameterFile</parameter_type>
<key>outstats</key>
<name>XML file containing mean and variance of each feature.</name>
<description>XML file containing mean and variance of each feature.</description>
<isFolder />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_StringList">ParameterString</parameter_type>
<key>feat</key>
<name>List of features to consider for statistics.</name>
<description>List of features to consider for statistics.</description>
<options />
<default />
</parameter>
</root>
@@ -0,0 +1,56 @@
<root>
<key>ComputePolylineFeatureFromImage</key>
<exec>otbcli_ComputePolylineFeatureFromImage</exec>
<longname>Compute Polyline Feature From Image</longname>
<group>Feature Extraction</group>
<description>This application compute for each studied polyline, contained in the input VectorData, the choosen descriptors.</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>in</key>
<name>Input Image</name>
<description>An image to compute the descriptors on.</description>
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputVectorData">ParameterVector</parameter_type>
<key>vd</key>
<name>Vector Data</name>
<description>Vector data containing the polylines where the features will be computed.</description>
<shapetype />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>elev.default</key>
<name>Default elevation</name>
<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>
<minValue />
<maxValue />
<default>0</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
<key>expr</key>
<name>Feature expression</name>
<description>The feature formula (b1 &lt; 0.3) where b1 is the standard name of input image first band</description>
<default />
<multiline />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_String">ParameterString</parameter_type>
<key>field</key>
<name>Feature name</name>
<description>The field name corresponding to the feature codename (NONDVI, ROADSA...)</description>
<default />
<multiline />
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputVectorData">OutputVector</parameter_type>
<key>out</key>
<name>Output Vector Data</name>
<description>The output vector data containing polylines with a new field</description>
<hidden />
</parameter>
</root>
Expand Up @@ -58,7 +58,7 @@
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>elev.default</key>
<name>Default elevation</name>
<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>
<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>
<minValue />
<maxValue />
<default>0</default>
Expand Down
78 changes: 78 additions & 0 deletions python/plugins/processing/algs/otb/description/Convert.xml
@@ -0,0 +1,78 @@
<root>
<key>Convert</key>
<exec>otbcli_Convert</exec>
<longname>Image Conversion</longname>
<group>Image Manipulation</group>
<description>Convert an image to a different format, eventually rescaling the data and/or changing the pixel type.</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>in</key>
<name>Input image</name>
<description>Input image</description>
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
<key>type</key>
<name>Rescale type</name>
<description>Transfer function for the rescaling</description>
<options>
<choices>
<choice>none</choice>
<choice>linear</choice>
<choice>log2</choice>
</choices>
</options>
<default>0</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>type.linear.gamma</key>
<name>Gamma correction factor</name>
<description>Gamma correction factor</description>
<minValue />
<maxValue />
<default>1</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>mask</key>
<name>Input mask</name>
<description>The masked pixels won't be used to adapt the dynamic (the mask must have the same dimensions as the input image)</description>
<optional>True</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>hcp.high</key>
<name>High Cut Quantile</name>
<description>Quantiles to cut from histogram high values before computing min/max rescaling (in percent, 2 by default)</description>
<minValue />
<maxValue />
<default>2</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>hcp.low</key>
<name>Low Cut Quantile</name>
<description>Quantiles to cut from histogram low values before computing min/max rescaling (in percent, 2 by default)</description>
<minValue />
<maxValue />
<default>2</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
<key>out</key>
<name>Output Image</name>
<description>Output image</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
<key>ram</key>
<name>Available RAM (Mb)</name>
<description>Available memory for processing (in MB)</description>
<minValue />
<maxValue />
<default>128</default>
</parameter>
</root>
20 changes: 20 additions & 0 deletions python/plugins/processing/algs/otb/description/DEMConvert.xml
@@ -0,0 +1,20 @@
<root>
<key>DEMConvert</key>
<exec>otbcli_DEMConvert</exec>
<longname>DEM Conversion</longname>
<group>Image Manipulation</group>
<description>Converts a geo-referenced DEM image into a general raster file compatible with OTB DEM handling.</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>in</key>
<name>Input geo-referenced DEM</name>
<description>Input geo-referenced DEM to convert to general raster format.</description>
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputFilename">OutputFile</parameter_type>
<key>out</key>
<name>Prefix of the output files</name>
<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>
</parameter>
</root>
60 changes: 60 additions & 0 deletions python/plugins/processing/algs/otb/description/Despeckle-frost.xml
@@ -0,0 +1,60 @@
<root>
<key>Despeckle-frost</key>
<exec>otbcli_Despeckle</exec>
<longname>Despeckle (frost)</longname>
<group>Image Filtering</group>
<description>Perform speckle noise reduction on SAR image.</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>in</key>
<name>Input Image</name>
<description>Input image.</description>
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
<key>out</key>
<name>Output Image</name>
<description>Output image.</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
<key>ram</key>
<name>Available RAM (Mb)</name>
<description>Available memory for processing (in MB)</description>
<minValue />
<maxValue />
<default>128</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
<key>filter</key>
<name>speckle filtering method</name>
<description />
<options>
<choices>
<choice>frost</choice>
</choices>
</options>
<default>0</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Int">ParameterNumber</parameter_type>
<key>filter.frost.rad</key>
<name>Radius</name>
<description>Radius for frost filter</description>
<minValue />
<maxValue />
<default>1</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>filter.frost.deramp</key>
<name>deramp</name>
<description>Decrease factor declaration</description>
<minValue />
<maxValue />
<default>0.1</default>
</parameter>
</root>
60 changes: 60 additions & 0 deletions python/plugins/processing/algs/otb/description/Despeckle-lee.xml
@@ -0,0 +1,60 @@
<root>
<key>Despeckle-lee</key>
<exec>otbcli_Despeckle</exec>
<longname>Despeckle (lee)</longname>
<group>Image Filtering</group>
<description>Perform speckle noise reduction on SAR image.</description>
<parameter>
<parameter_type source_parameter_type="ParameterType_InputImage">ParameterRaster</parameter_type>
<key>in</key>
<name>Input Image</name>
<description>Input image.</description>
<optional>False</optional>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_OutputImage">OutputRaster</parameter_type>
<key>out</key>
<name>Output Image</name>
<description>Output image.</description>
<hidden />
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_RAM">ParameterNumber</parameter_type>
<key>ram</key>
<name>Available RAM (Mb)</name>
<description>Available memory for processing (in MB)</description>
<minValue />
<maxValue />
<default>128</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Choice">ParameterSelection</parameter_type>
<key>filter</key>
<name>speckle filtering method</name>
<description />
<options>
<choices>
<choice>lee</choice>
</choices>
</options>
<default>0</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Int">ParameterNumber</parameter_type>
<key>filter.lee.rad</key>
<name>Radius</name>
<description>Radius for lee filter</description>
<minValue />
<maxValue />
<default>1</default>
</parameter>
<parameter>
<parameter_type source_parameter_type="ParameterType_Float">ParameterNumber</parameter_type>
<key>filter.lee.nblooks</key>
<name>nb looks</name>
<description>Nb looks for lee filter</description>
<minValue />
<maxValue />
<default>1</default>
</parameter>
</root>

0 comments on commit 0cc92ff

Please sign in to comment.