diff --git a/python/plugins/processing/algs/otb/description/BandMathX.xml b/python/plugins/processing/algs/otb/description/BandMathX.xml new file mode 100644 index 00000000000..6c7f348d6e3 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/BandMathX.xml @@ -0,0 +1,55 @@ + + BandMathX + otbcli_BandMathX + Band Math X + Miscellaneous + This application performs mathematical operations on multiband images. +Mathematical formula interpretation is done via muParserX library : http://articles.beltoforion.de/article.php?a=muparserx + + ParameterMultipleInput + il + Input image list + Image list to perform computation on. + + False + + + OutputRaster + out + Output Image + Output image. + + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + + ParameterString + exp + Expressions + Mathematical expression to apply. + + + True + + + ParameterFile + incontext + Import context + A txt file containing user's constants and expressions. + + True + + + OutputFile + outcontext + Export context + A txt file where to save user's constants and expressions. + + diff --git a/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-raster.xml b/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-raster.xml index d42f3fd620e..92cba17e860 100644 --- a/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-raster.xml +++ b/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-raster.xml @@ -16,7 +16,6 @@ out Matrix output Filename to store the output matrix (csv format) - ParameterSelection diff --git a/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-vector.xml b/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-vector.xml index 42b830ccafc..46531907de2 100644 --- a/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-vector.xml +++ b/python/plugins/processing/algs/otb/description/ComputeConfusionMatrix-vector.xml @@ -16,7 +16,6 @@ out Matrix output Filename to store the output matrix (csv format) - ParameterSelection diff --git a/python/plugins/processing/algs/otb/description/ComputeImagesStatistics.xml b/python/plugins/processing/algs/otb/description/ComputeImagesStatistics.xml index 43c742d6796..60a2805afe9 100644 --- a/python/plugins/processing/algs/otb/description/ComputeImagesStatistics.xml +++ b/python/plugins/processing/algs/otb/description/ComputeImagesStatistics.xml @@ -26,6 +26,5 @@ out Output XML file XML filename where the statistics are saved for future reuse. - diff --git a/python/plugins/processing/algs/otb/description/ComputeOGRLayersFeaturesStatistics.xml b/python/plugins/processing/algs/otb/description/ComputeOGRLayersFeaturesStatistics.xml new file mode 100644 index 00000000000..9e977f02f11 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/ComputeOGRLayersFeaturesStatistics.xml @@ -0,0 +1,31 @@ + + ComputeOGRLayersFeaturesStatistics + otbcli_ComputeOGRLayersFeaturesStatistics + ComputeOGRLayersFeaturesStatistics + Segmentation + Compute statistics of the features in a set of OGR Layers + + ParameterFile + inshp + Name of the input shapefile + Name of the input shapefile + + False + + + ParameterFile + outstats + XML file containing mean and variance of each feature. + XML file containing mean and variance of each feature. + + False + + + ParameterString + feat + List of features to consider for statistics. + List of features to consider for statistics. + + + + diff --git a/python/plugins/processing/algs/otb/description/ComputePolylineFeatureFromImage.xml b/python/plugins/processing/algs/otb/description/ComputePolylineFeatureFromImage.xml new file mode 100644 index 00000000000..2540299d4ac --- /dev/null +++ b/python/plugins/processing/algs/otb/description/ComputePolylineFeatureFromImage.xml @@ -0,0 +1,56 @@ + + ComputePolylineFeatureFromImage + otbcli_ComputePolylineFeatureFromImage + Compute Polyline Feature From Image + Feature Extraction + This application compute for each studied polyline, contained in the input VectorData, the choosen descriptors. + + ParameterRaster + in + Input Image + An image to compute the descriptors on. + False + + + ParameterVector + vd + Vector Data + Vector data containing the polylines where the features will be computed. + + False + + + ParameterNumber + elev.default + Default elevation + 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. + + + 0 + + + ParameterString + expr + Feature expression + The feature formula (b1 < 0.3) where b1 is the standard name of input image first band + + + False + + + ParameterString + field + Feature name + The field name corresponding to the feature codename (NONDVI, ROADSA...) + + + False + + + OutputVector + out + Output Vector Data + The output vector data containing polylines with a new field + + + diff --git a/python/plugins/processing/algs/otb/description/ConnectedComponentSegmentation.xml b/python/plugins/processing/algs/otb/description/ConnectedComponentSegmentation.xml index 69292833ace..8fad26e1b54 100644 --- a/python/plugins/processing/algs/otb/description/ConnectedComponentSegmentation.xml +++ b/python/plugins/processing/algs/otb/description/ConnectedComponentSegmentation.xml @@ -58,7 +58,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 diff --git a/python/plugins/processing/algs/otb/description/Convert.xml b/python/plugins/processing/algs/otb/description/Convert.xml new file mode 100644 index 00000000000..5d527e1bf4e --- /dev/null +++ b/python/plugins/processing/algs/otb/description/Convert.xml @@ -0,0 +1,78 @@ + + Convert + otbcli_Convert + Image Conversion + Image Manipulation + Convert an image to a different format, eventually rescaling the data and/or changing the pixel type. + + ParameterRaster + in + Input image + Input image + False + + + ParameterSelection + type + Rescale type + Transfer function for the rescaling + + + none + linear + log2 + + + 0 + + + ParameterNumber + type.linear.gamma + Gamma correction factor + Gamma correction factor + + + 1 + + + ParameterRaster + mask + Input mask + The masked pixels won't be used to adapt the dynamic (the mask must have the same dimensions as the input image) + True + + + ParameterNumber + hcp.high + High Cut Quantile + Quantiles to cut from histogram high values before computing min/max rescaling (in percent, 2 by default) + + + 2 + + + ParameterNumber + hcp.low + Low Cut Quantile + Quantiles to cut from histogram low values before computing min/max rescaling (in percent, 2 by default) + + + 2 + + + OutputRaster + out + Output Image + Output image + + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + diff --git a/python/plugins/processing/algs/otb/description/DEMConvert.xml b/python/plugins/processing/algs/otb/description/DEMConvert.xml new file mode 100644 index 00000000000..8e017ebe133 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/DEMConvert.xml @@ -0,0 +1,20 @@ + + DEMConvert + otbcli_DEMConvert + DEM Conversion + Image Manipulation + Converts a geo-referenced DEM image into a general raster file compatible with OTB DEM handling. + + ParameterRaster + in + Input geo-referenced DEM + Input geo-referenced DEM to convert to general raster format. + False + + + OutputFile + out + Prefix of the output files + 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. + + diff --git a/python/plugins/processing/algs/otb/description/Despeckle-frost.xml b/python/plugins/processing/algs/otb/description/Despeckle-frost.xml new file mode 100644 index 00000000000..88fcada626b --- /dev/null +++ b/python/plugins/processing/algs/otb/description/Despeckle-frost.xml @@ -0,0 +1,60 @@ + + Despeckle-frost + otbcli_Despeckle + Despeckle (frost) + Image Filtering + Perform speckle noise reduction on SAR image. + + ParameterRaster + in + Input Image + Input image. + False + + + OutputRaster + out + Output Image + Output image. + + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + + ParameterSelection + filter + speckle filtering method + + + + frost + + + 0 + + + ParameterNumber + filter.frost.rad + Radius + Radius for frost filter + + + 1 + + + ParameterNumber + filter.frost.deramp + deramp + Decrease factor declaration + + + 0.1 + + diff --git a/python/plugins/processing/algs/otb/description/Despeckle-lee.xml b/python/plugins/processing/algs/otb/description/Despeckle-lee.xml new file mode 100644 index 00000000000..8eb044d5e2b --- /dev/null +++ b/python/plugins/processing/algs/otb/description/Despeckle-lee.xml @@ -0,0 +1,60 @@ + + Despeckle-lee + otbcli_Despeckle + Despeckle (lee) + Image Filtering + Perform speckle noise reduction on SAR image. + + ParameterRaster + in + Input Image + Input image. + False + + + OutputRaster + out + Output Image + Output image. + + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + + ParameterSelection + filter + speckle filtering method + + + + lee + + + 0 + + + ParameterNumber + filter.lee.rad + Radius + Radius for lee filter + + + 1 + + + ParameterNumber + filter.lee.nblooks + nb looks + Nb looks for lee filter + + + 1 + + diff --git a/python/plugins/processing/algs/otb/description/DimensionalityReduction-ica.xml b/python/plugins/processing/algs/otb/description/DimensionalityReduction-ica.xml index 4123cfec5f3..5b98c8c73da 100644 --- a/python/plugins/processing/algs/otb/description/DimensionalityReduction-ica.xml +++ b/python/plugins/processing/algs/otb/description/DimensionalityReduction-ica.xml @@ -74,8 +74,7 @@ OutputFile outmatrix - Transformation matrix output + Transformation matrix output (text format) Filename to store the transformation matrix (csv format) - diff --git a/python/plugins/processing/algs/otb/description/DimensionalityReduction-maf.xml b/python/plugins/processing/algs/otb/description/DimensionalityReduction-maf.xml index 99936940c9e..10aac2d6107 100644 --- a/python/plugins/processing/algs/otb/description/DimensionalityReduction-maf.xml +++ b/python/plugins/processing/algs/otb/description/DimensionalityReduction-maf.xml @@ -49,8 +49,7 @@ OutputFile outmatrix - Transformation matrix output + Transformation matrix output (text format) Filename to store the transformation matrix (csv format) - diff --git a/python/plugins/processing/algs/otb/description/DimensionalityReduction-napca.xml b/python/plugins/processing/algs/otb/description/DimensionalityReduction-napca.xml index 752c0fe1541..b9b6be641f0 100644 --- a/python/plugins/processing/algs/otb/description/DimensionalityReduction-napca.xml +++ b/python/plugins/processing/algs/otb/description/DimensionalityReduction-napca.xml @@ -74,8 +74,7 @@ OutputFile outmatrix - Transformation matrix output + Transformation matrix output (text format) Filename to store the transformation matrix (csv format) - diff --git a/python/plugins/processing/algs/otb/description/DimensionalityReduction-pca.xml b/python/plugins/processing/algs/otb/description/DimensionalityReduction-pca.xml index 2a6e83af65e..e4cc02a5486 100644 --- a/python/plugins/processing/algs/otb/description/DimensionalityReduction-pca.xml +++ b/python/plugins/processing/algs/otb/description/DimensionalityReduction-pca.xml @@ -56,8 +56,7 @@ OutputFile outmatrix - Transformation matrix output + Transformation matrix output (text format) Filename to store the transformation matrix (csv format) - diff --git a/python/plugins/processing/algs/otb/description/ExtractROI-fit.xml b/python/plugins/processing/algs/otb/description/ExtractROI-fit.xml index ec498b2d274..968cbd8f277 100644 --- a/python/plugins/processing/algs/otb/description/ExtractROI-fit.xml +++ b/python/plugins/processing/algs/otb/description/ExtractROI-fit.xml @@ -50,7 +50,7 @@ ParameterNumber mode.fit.elev.default Default elevation - 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. + 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. 0 diff --git a/python/plugins/processing/algs/otb/description/ImageClassifier.xml b/python/plugins/processing/algs/otb/description/ImageClassifier.xml index 2f4b659566d..4f799e5e299 100644 --- a/python/plugins/processing/algs/otb/description/ImageClassifier.xml +++ b/python/plugins/processing/algs/otb/description/ImageClassifier.xml @@ -15,7 +15,7 @@ ParameterRaster mask Input Mask - The mask allows restricting classification of the input image to the area where mask pixel values are greater than 0. + The mask allows to restrict classification of the input image to the area where mask pixel values are greater than 0. True diff --git a/python/plugins/processing/algs/otb/description/KMeansClassification.xml b/python/plugins/processing/algs/otb/description/KMeansClassification.xml index 7c2d15b7138..94e0f902478 100644 --- a/python/plugins/processing/algs/otb/description/KMeansClassification.xml +++ b/python/plugins/processing/algs/otb/description/KMeansClassification.xml @@ -75,6 +75,5 @@ outmeans Centroid filename Output text file containing centroid positions - diff --git a/python/plugins/processing/algs/otb/description/KmzExport.xml b/python/plugins/processing/algs/otb/description/KmzExport.xml index 38f3cec7a96..ea7d4f44d2d 100644 --- a/python/plugins/processing/algs/otb/description/KmzExport.xml +++ b/python/plugins/processing/algs/otb/description/KmzExport.xml @@ -16,7 +16,6 @@ out Output .kmz product Output Kmz product directory (with .kmz extension) - ParameterNumber @@ -45,7 +44,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 diff --git a/python/plugins/processing/algs/otb/description/LSMSVectorization.xml b/python/plugins/processing/algs/otb/description/LSMSVectorization.xml index 2d908bddb4d..04a4ab8db63 100644 --- a/python/plugins/processing/algs/otb/description/LSMSVectorization.xml +++ b/python/plugins/processing/algs/otb/description/LSMSVectorization.xml @@ -23,7 +23,6 @@ out Output GIS vector file The output GIS vector file, representing the vectorized version of the segmented image where the features of the polygons are the radiometric means and variances. - ParameterNumber diff --git a/python/plugins/processing/algs/otb/description/MeanShiftSmoothing.xml b/python/plugins/processing/algs/otb/description/MeanShiftSmoothing.xml index d0253d84d00..641fa82caec 100644 --- a/python/plugins/processing/algs/otb/description/MeanShiftSmoothing.xml +++ b/python/plugins/processing/algs/otb/description/MeanShiftSmoothing.xml @@ -1,7 +1,7 @@ MeanShiftSmoothing otbcli_MeanShiftSmoothing - Mean Shift filtering (can be used as Exact Large-Scale Mean-Shift segmentation, step 1) + Exact Large-Scale Mean-Shift segmentation, step 1 (smoothing) Image Filtering Perform mean shift filtering @@ -25,6 +25,15 @@ The spatial image output. Spatial image output is a displacement map (pixel position after convergence). + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + ParameterNumber spatialr diff --git a/python/plugins/processing/algs/otb/description/OGRLayerClassifier.xml b/python/plugins/processing/algs/otb/description/OGRLayerClassifier.xml new file mode 100644 index 00000000000..05be660b57b --- /dev/null +++ b/python/plugins/processing/algs/otb/description/OGRLayerClassifier.xml @@ -0,0 +1,46 @@ + + OGRLayerClassifier + otbcli_OGRLayerClassifier + OGRLayerClassifier + Segmentation + Classify an OGR layer based on a machine learning model and a list of features to consider. + + ParameterFile + inshp + Name of the input shapefile + Name of the input shapefile + + False + + + ParameterFile + instats + XML file containing mean and variance of each feature. + XML file containing mean and variance of each feature. + + False + + + OutputFile + insvm + Input model filename. + Input model filename. + + + ParameterString + feat + Features + Features to be calculated + + + + + ParameterString + cfield + Field containing the predicted class. + Field containing the predicted class + predicted + + False + + diff --git a/python/plugins/processing/algs/otb/description/OpticalCalibration.xml b/python/plugins/processing/algs/otb/description/OpticalCalibration.xml index 2be22abf36e..e564f2ba82d 100644 --- a/python/plugins/processing/algs/otb/description/OpticalCalibration.xml +++ b/python/plugins/processing/algs/otb/description/OpticalCalibration.xml @@ -3,7 +3,7 @@ otbcli_OpticalCalibration Optical calibration Calibration - Perform optical calibration TOA/TOC (Top Of Atmosphere/Top Of Canopy). Supported sensors: QuickBird, Ikonos, WorldView2, Formosat, Spot5, Pleiades + Perform optical calibration TOA/TOC (Top Of Atmosphere/Top Of Canopy). Supported sensors: QuickBird, Ikonos, WorldView2, Formosat, Spot5, Pleiades, Spot6. For other sensors the application also allows to provide calibration parameters manually. ParameterRaster in @@ -35,32 +35,133 @@ toa + toatoim 0 - ParameterBoolean - milli - Convert to milli reflectance - Flag to use milli-reflectance instead of reflectance. -This allows saving the image with integer pixel type (in the range [0, 1000] instead of floating point in the range [0, 1]. In order to do that, use this option and set the output pixel type (-out filename uint16 for example) - True + ParameterNumber + acqui.minute + Minute + Minute (0-59) + + + 0 - ParameterBoolean - clamp - Clamp of reflectivity values between [0, 100] - Clamping in the range [0, 100]. It can be useful to preserve area with specular reflectance. - True + ParameterNumber + acqui.hour + Hour + Hour (0-23) + + + 12 + + + ParameterNumber + acqui.day + Day + Day (1-31) + + + 1 + + + ParameterNumber + acqui.month + Month + Month (1-12) + + + 1 + + + ParameterNumber + acqui.year + Year + Year + + + 2000 + + + ParameterNumber + acqui.sun.elev + Sun elevation angle (deg) + Sun elevation angle (in degrees) + + + 90 + + + ParameterNumber + acqui.sun.azim + Sun azimuth angle (deg) + Sun azimuth angle (in degrees) + + + 0 + + + ParameterNumber + acqui.view.elev + Viewing elevation angle (deg) + Viewing elevation angle (in degrees) + + + 90 + + + ParameterNumber + acqui.view.azim + Viewing azimuth angle (deg) + Viewing azimuth angle (in degrees) + + + 0 ParameterFile - rsr - Relative Spectral Response File - Sensor relative spectral response file -By default the application gets these information in the metadata + acqui.gainbias + Gains | biases + Gains | biases True - + + ParameterFile + acqui.solarilluminations + Solar illuminations + Solar illuminations (one value per band) + + True + + + ParameterFile + atmo.rsr + Relative Spectral Response File + Sensor relative spectral response file +By default the application gets these informations in the metadata + + True + + + ParameterNumber + atmo.radius + Window radius (adjacency effects) + Window radius for adjacency effects correctionsSetting this parameters will enable the correction ofadjacency effects + + + 2 + + + ParameterNumber + atmo.pixsize + Pixel size (in km) + Pixel size (in km )used tocompute adjacency effects, it doesn't have tomatch the image spacing + + + 1 + + diff --git a/python/plugins/processing/algs/otb/description/OrthoRectification-epsg.xml b/python/plugins/processing/algs/otb/description/OrthoRectification-epsg.xml index caa3d102881..15b225cb376 100644 --- a/python/plugins/processing/algs/otb/description/OrthoRectification-epsg.xml +++ b/python/plugins/processing/algs/otb/description/OrthoRectification-epsg.xml @@ -3,7 +3,7 @@ otbcli_OrthoRectification OrthoRectification (epsg) Geometry - This application allows ortho-rectifying optical images from supported sensors. + This application allows to ortho-rectify optical images from supported sensors. ParameterRaster @@ -66,7 +66,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -75,7 +75,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. bco @@ -89,7 +89,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -98,7 +98,7 @@ ParameterNumber opt.ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/OrthoRectification-fit-to-ortho.xml b/python/plugins/processing/algs/otb/description/OrthoRectification-fit-to-ortho.xml index 7bcfbdc21c2..4c9cc1ed71a 100644 --- a/python/plugins/processing/algs/otb/description/OrthoRectification-fit-to-ortho.xml +++ b/python/plugins/processing/algs/otb/description/OrthoRectification-fit-to-ortho.xml @@ -3,7 +3,7 @@ otbcli_OrthoRectification OrthoRectification (fit-to-ortho) Geometry - This application allows ortho-rectifying optical images from supported sensors. + This application allows to ortho-rectify optical images from supported sensors. ParameterRaster @@ -51,7 +51,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -60,7 +60,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. bco @@ -74,7 +74,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -83,7 +83,7 @@ ParameterNumber opt.ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/OrthoRectification-lambert-WGS84.xml b/python/plugins/processing/algs/otb/description/OrthoRectification-lambert-WGS84.xml index 92c28934ed8..8282aeeae08 100644 --- a/python/plugins/processing/algs/otb/description/OrthoRectification-lambert-WGS84.xml +++ b/python/plugins/processing/algs/otb/description/OrthoRectification-lambert-WGS84.xml @@ -3,7 +3,7 @@ otbcli_OrthoRectification OrthoRectification (lambert-WGS84) Geometry - This application allows ortho-rectifying optical images from supported sensors. + This application allows to ortho-rectify optical images from supported sensors. ParameterRaster @@ -59,7 +59,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -68,7 +68,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. bco @@ -82,7 +82,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -91,7 +91,7 @@ ParameterNumber opt.ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/OrthoRectification-utm.xml b/python/plugins/processing/algs/otb/description/OrthoRectification-utm.xml index 9da71f3a3de..f0dafe09515 100644 --- a/python/plugins/processing/algs/otb/description/OrthoRectification-utm.xml +++ b/python/plugins/processing/algs/otb/description/OrthoRectification-utm.xml @@ -3,7 +3,7 @@ otbcli_OrthoRectification OrthoRectification (utm) Geometry - This application allows ortho-rectifying optical images from supported sensors. + This application allows to ortho-rectify optical images from supported sensors. ParameterRaster @@ -35,7 +35,7 @@ ParameterNumber map.utm.zone Zone number - The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere) + The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere) 31 @@ -73,7 +73,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -82,7 +82,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. bco @@ -96,7 +96,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -105,7 +105,7 @@ ParameterNumber opt.ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/Rasterization-image.xml b/python/plugins/processing/algs/otb/description/Rasterization-image.xml new file mode 100644 index 00000000000..9799f180c68 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/Rasterization-image.xml @@ -0,0 +1,78 @@ + + Rasterization-image + otbcli_Rasterization + Rasterization (image) + Vector Data Manipulation + Rasterize a vector dataset. + + ParameterFile + in + Input vector dataset + The input vector dataset to be rasterized + + False + + + OutputRaster + out + Ouptut image + An output image containing the rasterized vector dataset + + + + ParameterRaster + im + Input reference image + A reference image from which to import output grid and projection reference system information. + True + + + ParameterNumber + background + Background value + Default value for pixels not belonging to any geometry + + + 0 + + + ParameterSelection + mode + Rasterization mode + Choice of rasterization modes + + + binary + attribute + + + 0 + + + ParameterNumber + mode.binary.foreground + Foreground value + Value for pixels inside a geometry + + + 255 + + + ParameterString + mode.attribute.field + The attribute field to burn + Name of the attribute field to burn + DN + + False + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + diff --git a/python/plugins/processing/algs/otb/description/Rasterization-manual.xml b/python/plugins/processing/algs/otb/description/Rasterization-manual.xml new file mode 100644 index 00000000000..229e44131c1 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/Rasterization-manual.xml @@ -0,0 +1,134 @@ + + Rasterization-manual + otbcli_Rasterization + Rasterization (manual) + Vector Data Manipulation + Rasterize a vector dataset. + + ParameterFile + in + Input vector dataset + The input vector dataset to be rasterized + + False + + + OutputRaster + out + Ouptut image + An output image containing the rasterized vector dataset + + + + ParameterNumber + szx + Output size x + Output size along x axis (useless if support image is given) + + + 0 + + + ParameterNumber + szy + Output size y + Output size along y axis (useless if support image is given) + + + 0 + + + ParameterNumber + epsg + Output EPSG code + EPSG code for the output projection reference system (EPSG 4326 for WGS84, 32631 for UTM31N...,useless if support image is given) + + + 0 + + + ParameterNumber + orx + Output Upper-left x + Output upper-left corner x coordinate (useless if support image is given) + + + 0.0 + + + ParameterNumber + ory + Output Upper-left y + Output upper-left corner y coordinate (useless if support image is given) + + + 0.0 + + + ParameterNumber + spx + Spacing (GSD) x + Spacing (ground sampling distance) along x axis (useless if support image is given) + + + 0.0 + + + ParameterNumber + spy + Spacing (GSD) y + Spacing (ground sampling distance) along y axis (useless if support image is given) + + + 0.0 + + + ParameterNumber + background + Background value + Default value for pixels not belonging to any geometry + + + 0 + + + ParameterSelection + mode + Rasterization mode + Choice of rasterization modes + + + binary + attribute + + + 0 + + + ParameterNumber + mode.binary.foreground + Foreground value + Value for pixels inside a geometry + + + 255 + + + ParameterString + mode.attribute.field + The attribute field to burn + Name of the attribute field to burn + DN + + False + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + diff --git a/python/plugins/processing/algs/otb/description/ReadImageInfo.xml b/python/plugins/processing/algs/otb/description/ReadImageInfo.xml index 37efd9849da..0e96948f43b 100644 --- a/python/plugins/processing/algs/otb/description/ReadImageInfo.xml +++ b/python/plugins/processing/algs/otb/description/ReadImageInfo.xml @@ -15,7 +15,7 @@ ParameterBoolean keywordlist Display the OSSIM keywordlist - Output the OSSIM keyword list. It contains metadata information (sensor model, geometry ). Information are stored in keyword list (pairs of key/value) + Output the OSSIM keyword list. It contains metadata information (sensor model, geometry ). Informations are stored in keyword list (pairs of key/value) True diff --git a/python/plugins/processing/algs/otb/description/RigidTransformResample-id.xml b/python/plugins/processing/algs/otb/description/RigidTransformResample-id.xml index c59424e12e2..8ff7125e59f 100644 --- a/python/plugins/processing/algs/otb/description/RigidTransformResample-id.xml +++ b/python/plugins/processing/algs/otb/description/RigidTransformResample-id.xml @@ -52,7 +52,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. nn @@ -66,7 +66,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -75,7 +75,7 @@ ParameterNumber ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/RigidTransformResample-rotation.xml b/python/plugins/processing/algs/otb/description/RigidTransformResample-rotation.xml index 55f7254b198..80d7333fc4f 100644 --- a/python/plugins/processing/algs/otb/description/RigidTransformResample-rotation.xml +++ b/python/plugins/processing/algs/otb/description/RigidTransformResample-rotation.xml @@ -61,7 +61,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. nn @@ -75,7 +75,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -84,7 +84,7 @@ ParameterNumber ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/RigidTransformResample-translation.xml b/python/plugins/processing/algs/otb/description/RigidTransformResample-translation.xml index 5067c10e060..031ef35889a 100644 --- a/python/plugins/processing/algs/otb/description/RigidTransformResample-translation.xml +++ b/python/plugins/processing/algs/otb/description/RigidTransformResample-translation.xml @@ -70,7 +70,7 @@ ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. nn @@ -84,7 +84,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 @@ -93,7 +93,7 @@ ParameterNumber ram Available RAM (Mb) - This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) + This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities) 128 diff --git a/python/plugins/processing/algs/otb/description/SFSTextureExtraction.xml b/python/plugins/processing/algs/otb/description/SFSTextureExtraction.xml new file mode 100644 index 00000000000..34c9ec322c2 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/SFSTextureExtraction.xml @@ -0,0 +1,84 @@ + + SFSTextureExtraction + otbcli_SFSTextureExtraction + SFS Texture Extraction + Feature Extraction + Computes Structural Feature Set textures on every pixel of the input image selected channel + + ParameterRaster + in + Input Image + The input image to compute the features on. + False + + + ParameterNumber + channel + Selected Channel + The selected channel index + + + 1 + + + ParameterNumber + ram + Available RAM (Mb) + Available memory for processing (in MB) + + + 128 + + + ParameterNumber + parameters.spethre + Spectral Threshold + Spectral Threshold + + + 50 + + + ParameterNumber + parameters.spathre + Spatial Threshold + Spatial Threshold + + + 100 + + + ParameterNumber + parameters.nbdir + Number of Direction + Number of Direction + + + 20 + + + ParameterNumber + parameters.alpha + Alpha + Alpha + + + 1 + + + ParameterNumber + parameters.maxcons + Ratio Maximum Consideration Number + Ratio Maximum Consideration Number + + + 5 + + + OutputRaster + out + Feature Output Image + Output image containing the SFS texture features. + + + diff --git a/python/plugins/processing/algs/otb/description/SOMClassification.xml b/python/plugins/processing/algs/otb/description/SOMClassification.xml index fd13d30e436..9c1daa046cd 100644 --- a/python/plugins/processing/algs/otb/description/SOMClassification.xml +++ b/python/plugins/processing/algs/otb/description/SOMClassification.xml @@ -43,15 +43,6 @@ 0 - - ParameterNumber - sl - StreamingLines - Number of lines in each streaming block (used during data sampling) - - - 0 - OutputRaster som diff --git a/python/plugins/processing/algs/otb/description/Segmentation-cc.xml b/python/plugins/processing/algs/otb/description/Segmentation-cc.xml index 9ed0d3c2b9d..4910f6be75a 100644 --- a/python/plugins/processing/algs/otb/description/Segmentation-cc.xml +++ b/python/plugins/processing/algs/otb/description/Segmentation-cc.xml @@ -49,13 +49,12 @@ mode.vector.out Output vector file The output vector file or database (name can be anything understood by OGR) - ParameterSelection mode.vector.outmode Writing mode for the output vector file - This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. + This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. ulco @@ -100,7 +99,7 @@ ParameterNumber mode.vector.simplify Simplify polygons - Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database. + Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database. 0.1 diff --git a/python/plugins/processing/algs/otb/description/Segmentation-meanshift.xml b/python/plugins/processing/algs/otb/description/Segmentation-meanshift.xml index d8df0a559a6..ed498dc6c1d 100644 --- a/python/plugins/processing/algs/otb/description/Segmentation-meanshift.xml +++ b/python/plugins/processing/algs/otb/description/Segmentation-meanshift.xml @@ -85,13 +85,12 @@ mode.vector.out Output vector file The output vector file or database (name can be anything understood by OGR) - ParameterSelection mode.vector.outmode Writing mode for the output vector file - This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. + This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. ulco @@ -136,7 +135,7 @@ ParameterNumber mode.vector.simplify Simplify polygons - Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database. + Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database. 0.1 diff --git a/python/plugins/processing/algs/otb/description/Segmentation-mprofiles.xml b/python/plugins/processing/algs/otb/description/Segmentation-mprofiles.xml index 3c193f4c763..e6e5fa645d8 100644 --- a/python/plugins/processing/algs/otb/description/Segmentation-mprofiles.xml +++ b/python/plugins/processing/algs/otb/description/Segmentation-mprofiles.xml @@ -76,13 +76,12 @@ mode.vector.out Output vector file The output vector file or database (name can be anything understood by OGR) - ParameterSelection mode.vector.outmode Writing mode for the output vector file - This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. + This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. ulco @@ -127,7 +126,7 @@ ParameterNumber mode.vector.simplify Simplify polygons - Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database. + Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database. 0.1 diff --git a/python/plugins/processing/algs/otb/description/Segmentation-watershed.xml b/python/plugins/processing/algs/otb/description/Segmentation-watershed.xml index 80577eab8fb..dcd127b999c 100644 --- a/python/plugins/processing/algs/otb/description/Segmentation-watershed.xml +++ b/python/plugins/processing/algs/otb/description/Segmentation-watershed.xml @@ -58,13 +58,12 @@ mode.vector.out Output vector file The output vector file or database (name can be anything understood by OGR) - ParameterSelection mode.vector.outmode Writing mode for the output vector file - This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. + This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format. ulco @@ -109,7 +108,7 @@ ParameterNumber mode.vector.simplify Simplify polygons - Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database. + Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database. 0.1 diff --git a/python/plugins/processing/algs/otb/description/Smoothing-anidif.xml b/python/plugins/processing/algs/otb/description/Smoothing-anidif.xml index 565747cda83..3f1d1c62d69 100644 --- a/python/plugins/processing/algs/otb/description/Smoothing-anidif.xml +++ b/python/plugins/processing/algs/otb/description/Smoothing-anidif.xml @@ -52,9 +52,18 @@ ParameterNumber type.anidif.nbiter Nb Iterations - Number of iterations + Controls the sensitivity of the conductance term 10 + + ParameterNumber + type.anidif.conductance + Conductance + + + + 1 + diff --git a/python/plugins/processing/algs/otb/description/StereoFramework.xml b/python/plugins/processing/algs/otb/description/StereoFramework.xml index da8488fa606..e1a2de33a02 100644 --- a/python/plugins/processing/algs/otb/description/StereoFramework.xml +++ b/python/plugins/processing/algs/otb/description/StereoFramework.xml @@ -35,7 +35,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -62,7 +62,7 @@ ParameterSelection output.fusionmethod Method to fuse measures in each DSM cell - This parameter allows choosing the method used to fuse elevation measurements in each output DSM cell + This parameter allows to choose the method used to fuse elevation measurements in each output DSM cell max @@ -167,7 +167,7 @@ ParameterNumber map.utm.zone Zone number - The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere) + The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere) 31 @@ -191,8 +191,8 @@ ParameterNumber stereorect.fwdgridstep - Step of the deformation grid (in pixels) - Stereo-rectification deformation grid only varies slowly. Therefore, it is recommended to use a coarser grid (higher step value) in case of large images + Step of the displacement grid (in pixels) + Stereo-rectification displacement grid only varies slowly. Therefore, it is recommended to use a coarser grid (higher step value) in case of large images 16 @@ -201,7 +201,7 @@ ParameterNumber stereorect.invgridssrate Sub-sampling rate for epipolar grid inversion - Grid inversion is an heavy process that implies spline regression on control points. To avoid eating to much memory, this parameter allows sub-sampling first the field to invert. + Grid inversion is an heavy process that implies spline regression on control points. To avoid eating to much memory, this parameter allows to first sub-sample the field to invert. 10 @@ -298,7 +298,7 @@ ParameterNumber mask.variancet Discard pixels with low local variance - This parameter allows discarding pixels whose local variance is too small (the size of the neighborhood is given by the radius parameter) + This parameter allows to discard pixels whose local variance is too small (the size of the neighborhood is given by the radius parameter) 50 diff --git a/python/plugins/processing/algs/otb/description/Superimpose.xml b/python/plugins/processing/algs/otb/description/Superimpose.xml index 7affe1563eb..d5957686683 100644 --- a/python/plugins/processing/algs/otb/description/Superimpose.xml +++ b/python/plugins/processing/algs/otb/description/Superimpose.xml @@ -22,7 +22,7 @@ ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -43,11 +43,24 @@ Output reprojected image. + + ParameterSelection + mode + Mode + Superimposition mode + + + default + phr + + + 0 + ParameterSelection interpolator Interpolation - This group of parameters allows defining how the input image will be interpolated during resampling. + This group of parameters allows to define how the input image will be interpolated during resampling. bco @@ -61,7 +74,7 @@ ParameterNumber interpolator.bco.radius Radius for bicubic interpolation - This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. + This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts. 2 diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-ann.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-ann.xml index f1b36f26f66..27b87d26fb7 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-ann.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-ann.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-bayes.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-bayes.xml index 8ff19525f99..8b57bfa928e 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-bayes.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-bayes.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-boost.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-boost.xml index 9b8a83c29c3..e2f33d2d1d2 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-boost.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-boost.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-dt.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-dt.xml index e2ff654a3d6..3ea930b2989 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-dt.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-dt.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-gbt.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-gbt.xml index ca31a6ec219..dbe0af45666 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-gbt.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-gbt.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-knn.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-knn.xml index a7a4eebf1ee..21f960bca06 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-knn.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-knn.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-libsvm.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-libsvm.xml index c6ced17aa04..a9b91a8e341 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-libsvm.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-libsvm.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-rf.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-rf.xml index a24fc6be004..b20210a79a4 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-rf.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-rf.xml @@ -33,20 +33,18 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - ParameterNumber elev.default Default elevation - 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. + 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. 0 @@ -69,6 +67,15 @@ 1000 + + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + ParameterBoolean sample.edg diff --git a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-svm.xml b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-svm.xml index 5abf4ce4924..7f0af42ed4e 100644 --- a/python/plugins/processing/algs/otb/description/TrainImagesClassifier-svm.xml +++ b/python/plugins/processing/algs/otb/description/TrainImagesClassifier-svm.xml @@ -33,26 +33,24 @@ io.confmatout Output confusion matrix Output file containing the confusion matrix (.csv format). - OutputFile io.out Output model Output file containing the model estimated (.txt format). - - *ParameterNumber + ParameterNumber elev.default Default elevation - 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. + 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. 0 - *ParameterNumber + ParameterNumber sample.mt Maximum training sample size per class Maximum size per class (in pixels) of the training sample list (default = 1000) (no limit = -1). If equal to -1, then the maximal size of the available training sample list per class will be equal to the surface area of the smallest class multiplied by the training sample ratio. @@ -61,7 +59,7 @@ 1000 - *ParameterNumber + ParameterNumber sample.mv Maximum validation sample size per class Maximum size per class (in pixels) of the validation sample list (default = 1000) (no limit = -1). If equal to -1, then the maximal size of the available validation sample list per class will be equal to the surface area of the smallest class multiplied by the validation sample ratio. @@ -70,7 +68,16 @@ 1000 - *ParameterBoolean + ParameterNumber + sample.bm + Bound sample number by minimum + Bound the number of samples for each class by the number of available samples by the smaller class. Proportions between training and validation are respected. Default is true (=1). + + + 1 + + + ParameterBoolean sample.edg On edge pixel inclusion Takes pixels on polygon edge into consideration when building training and validation samples. @@ -107,7 +114,7 @@ 0 - *ParameterSelection + ParameterSelection classifier.svm.m SVM Model Type Type of SVM formulation. @@ -145,7 +152,7 @@ 1 - *ParameterNumber + ParameterNumber classifier.svm.nu Parameter nu of a SVM optimization problem (NU_SVC / ONE_CLASS) Parameter nu of a SVM optimization problem. @@ -154,7 +161,7 @@ 0 - *ParameterNumber + ParameterNumber classifier.svm.coef0 Parameter coef0 of a kernel function (POLY / SIGMOID) Parameter coef0 of a kernel function (POLY / SIGMOID). @@ -163,7 +170,7 @@ 0 - *ParameterNumber + ParameterNumber classifier.svm.gamma Parameter gamma of a kernel function (POLY / RBF / SIGMOID) Parameter gamma of a kernel function (POLY / RBF / SIGMOID). @@ -172,7 +179,7 @@ 1 - *ParameterNumber + ParameterNumber classifier.svm.degree Parameter degree of a kernel function (POLY) Parameter degree of a kernel function (POLY). @@ -191,7 +198,7 @@ True - *ParameterNumber + ParameterNumber rand set user defined seed Set specific seed. with integer value. diff --git a/python/plugins/processing/algs/otb/description/TrainOGRLayersClassifier.xml b/python/plugins/processing/algs/otb/description/TrainOGRLayersClassifier.xml new file mode 100644 index 00000000000..b9f301930d2 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/TrainOGRLayersClassifier.xml @@ -0,0 +1,46 @@ + + TrainOGRLayersClassifier + otbcli_TrainOGRLayersClassifier + TrainOGRLayersClassifier + Segmentation + Train a SVM classifier based on labeled geometries and a list of features to consider. + + ParameterFile + inshp + Name of the input shapefile + Name of the input shapefile + + False + + + ParameterFile + instats + XML file containing mean and variance of each feature. + XML file containing mean and variance of each feature. + + False + + + OutputFile + outsvm + Output model filename. + Output model filename. + + + ParameterString + feat + List of features to consider for classification. + List of features to consider for classification. + + + + + ParameterString + cfield + Field containing the class id for supervision + Field containing the class id for supervision. Only geometries with this field available will be taken into account. + class + + False + + diff --git a/python/plugins/processing/algs/otb/description/VectorDataExtractROI.xml b/python/plugins/processing/algs/otb/description/VectorDataExtractROI.xml new file mode 100644 index 00000000000..843e65eed60 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/VectorDataExtractROI.xml @@ -0,0 +1,38 @@ + + VectorDataExtractROI + otbcli_VectorDataExtractROI + VectorData Extract ROI + Vector Data Manipulation + Perform an extract ROI on the input vector data according to the input image extent + + ParameterVector + io.vd + Input Vector data + Input vector data + + False + + + ParameterRaster + io.in + Support image + Support image that specifies the extracted region + False + + + OutputVector + io.out + Output Vector data + Output extracted vector data + + + + ParameterNumber + elev.default + Default elevation + 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. + + + 0 + + diff --git a/python/plugins/processing/algs/otb/description/VectorDataReprojection-image.xml b/python/plugins/processing/algs/otb/description/VectorDataReprojection-image.xml new file mode 100644 index 00000000000..d3a6755c4e1 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/VectorDataReprojection-image.xml @@ -0,0 +1,57 @@ + + VectorDataReprojection-image + otbcli_VectorDataReprojection + VectorDataReprojection (image) + Vector Data Manipulation + This application allows to reproject a vector data using support image projection reference, or a user specified map projection + + + ParameterFile + in.vd + Input vector data + The input vector data to reproject + + False + + + ParameterRaster + in.kwl + Use image keywords list + Optional input image to fill vector data with image kwl. + True + + + OutputFile + out.vd + Output vector data + The reprojected vector data + + + ParameterSelection + out.proj + Output Projection choice + + + + image + + + 0 + + + ParameterRaster + out.proj.image.in + Image used to get projection map + Projection map will be found using image metadata + False + + + ParameterNumber + elev.default + Default elevation + 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. + + + 0 + + diff --git a/python/plugins/processing/algs/otb/description/VectorDataReprojection-user.xml b/python/plugins/processing/algs/otb/description/VectorDataReprojection-user.xml new file mode 100644 index 00000000000..83ea9858414 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/VectorDataReprojection-user.xml @@ -0,0 +1,91 @@ + + VectorDataReprojection-user + otbcli_VectorDataReprojection + VectorDataReprojection (user) + Vector Data Manipulation + This application allows to reproject a vector data using support image projection reference, or a user specified map projection + + + ParameterFile + in.vd + Input vector data + The input vector data to reproject + + False + + + ParameterRaster + in.kwl + Use image keywords list + Optional input image to fill vector data with image kwl. + True + + + OutputFile + out.vd + Output vector data + The reprojected vector data + + + ParameterSelection + out.proj + Output Projection choice + + + + user + + + 0 + + + ParameterSelection + out.proj.user.map + Output Cartographic Map Projection + Parameters of the output map projection to be used. + + + utm + lambert2 + lambert93 + wgs + epsg + + + 0 + + + ParameterNumber + out.proj.user.map.utm.zone + Zone number + The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere) + + + 31 + + + ParameterBoolean + out.proj.user.map.utm.northhem + Northern Hemisphere + The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere. + True + + + ParameterNumber + out.proj.user.map.epsg.code + EPSG Code + See www.spatialreference.org to find which EPSG code is associated to your projection + + + 4326 + + + ParameterNumber + elev.default + Default elevation + 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. + + + 0 + + diff --git a/python/plugins/processing/algs/otb/description/VectorDataTransform.xml b/python/plugins/processing/algs/otb/description/VectorDataTransform.xml new file mode 100644 index 00000000000..509877afbcb --- /dev/null +++ b/python/plugins/processing/algs/otb/description/VectorDataTransform.xml @@ -0,0 +1,83 @@ + + VectorDataTransform + otbcli_VectorDataTransform + Vector Data Transformation + Vector Data Manipulation + Apply a transform to each vertex of the input VectorData + + ParameterVector + vd + Input Vector data + Input vector data to transform + + False + + + OutputVector + out + Output Vector data + Output transformed vector data + + + + ParameterRaster + in + Support image + Image needed as a support to the vector data + False + + + ParameterNumber + transform.tx + Translation X + Translation in the X direction (in pixels) + + + 0 + + + ParameterNumber + transform.ty + Translation Y + Translation in the Y direction (in pixels) + + + 0 + + + ParameterNumber + transform.ro + Rotation Angle + Angle of the rotation to apply in degrees + + + 0 + + + ParameterNumber + transform.centerx + Center X + X coordinate of the rotation center (in physical units) + + + 0 + + + ParameterNumber + transform.centery + Center Y + Y coordinate of the rotation center (in physical units) + + + 0 + + + ParameterNumber + transform.scale + Scale + The scale to apply + + + 1 + + diff --git a/python/plugins/processing/algs/otb/description/doc/BandMath.html b/python/plugins/processing/algs/otb/description/doc/BandMath.html index d51a52a2981..c6c9657d6e9 100644 --- a/python/plugins/processing/algs/otb/description/doc/BandMath.html +++ b/python/plugins/processing/algs/otb/description/doc/BandMath.html @@ -2,5 +2,5 @@ -

BandMath

Brief Description

Perform a mathematical operation on monoband images

Tags

Util

Long Description

This application performs a mathematical operation on monoband images. Mathematical formula interpretation is done via MuParser libraries http://muparser.sourceforge.net/

Parameters

  • [param] -il <string> Image list to perform computation on.. Mandatory: True. Default Value: "0"
  • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
  • [param] -exp <string> The mathematical expression to apply. -Use im1b1 for the first band, im1b2 for the second one.... Mandatory: True. Default Value: ""

Limitations

None

Authors

OTB-Team

See Also

Example of use

  • il: verySmallFSATSW_r.tif verySmallFSATSW_nir.tif verySmallFSATSW.tif

  • out: apTvUtBandMathOutput.tif

  • exp: "cos(im1b1)+im2b1*im3b1-im3b2+ndvi(im3b3, im3b4)"

\ No newline at end of file +

BandMath

Brief Description

Perform a mathematical operation on monoband images

Tags

Util

Long Description

This application performs a mathematical operation on monoband images. Mathematical formula interpretation is done via MuParser libraries http://muparser.sourceforge.net/.For MuParser version prior to v2 use 'and' and 'or' logical operators, and ternary operator 'if(; ; )'.For MuParser version superior to 2.0 uses '&&' and '||' logical operators, and C++ like ternary if-then-else operator.

Parameters

  • [param] -il <string> Image list to perform computation on.. Mandatory: True. Default Value: "0"
  • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
  • [param] -exp <string> The mathematical expression to apply. +Use im1b1 for the first band, im1b2 for the second one.... Mandatory: True. Default Value: ""
  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

Limitations

None

Authors

OTB-Team

See Also

Example of use

  • il: verySmallFSATSW_r.tif verySmallFSATSW_nir.tif verySmallFSATSW.tif

  • out: apTvUtBandMathOutput.tif

  • exp: "cos(im1b1)+im2b1*im3b1-im3b2+ndvi(im3b3, im3b4)"

\ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BandMathX.html b/python/plugins/processing/algs/otb/description/doc/BandMathX.html new file mode 100644 index 00000000000..d26b7fe65fc --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/BandMathX.html @@ -0,0 +1,98 @@ + + +

BandMathX

Brief 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

Tags

Util

Long Description

The goal of this documentation is to give the user some hints about the syntax used in this application. +The syntax is mainly constrained by the muparserx library, which can be considered as the core of the application. + + +- Fundamentals: + +The default prefix name for variables related to the ith input is 'im(i+1)'(note the indexing from 1 to N, for N inputs). +The following list summaries the available variables for input #0 (and so on for every input): + +im1 --> a pixel from first input, made of n components (n bands) +im1bj --> jth component of a pixel from first input (first band is indexed by 1) +im1bjNkxp --> a neighbourhood ('N') of pixels of the jth component from first input, of size kxp +im1PhyX and im1PhyY --> spacing of first input in X and Y directions (horizontal and vertical) +im1bjMean im1bjMin im1bjMax im1bjSum im1bjVar --> mean, min, max, sum, variance of jth band from first input (global statistics) + +Moreover, we also have the following generic variables: +idxX and idxY --> indices of the current pixel + +Always keep in mind that this application only addresses mathematically well-defined formulas. +For instance, it is not possible to add vectors of different dimensions (this implies the addition of a row vector with a column vector), +or add a scalar to a vector or a matrix, or divide two vectors, and so on... +Thus, it is important to remember that a pixel of n components is always represented as a row vector. + +Example : + + im1 + im2 (1) + +represents the addition of pixels from first and second inputs. This expression is consistent only if +both inputs have the same number of bands. +Note that it is also possible to use the following expressions to obtain the same result: + + im1b1 + im2b1 + im1b2 + im2b2 (2) + .... + +Nevertheless, the first expression is by far much pleaseant. We call this new functionnality the 'batch mode' +(performing the same operation in a band-to-band fashion). + + +- Operations involving neighborhoods of pixels: + +Another new fonctionnality is the possibility to perform operations that involve neighborhoods of pixels. +Variable related to such neighborhoods are always defined following the pattern imIbJNKxP, where: +- I is an number identifying the image input (remember, input #0 = im1, and so on) +- J is an number identifying the band (remember, first band is indexed by 1) +- KxP are two numbers that represent the size of the neighborhood (first one is related to the horizontal direction) +All neighborhood are centred, thus K and P must be odd numbers. +Many operators come with this new functionnality: dotpr, mean var median min max... +For instance, if im1 represents the pixel of 3 bands image: + + im1 - mean(im1b1N5x5,im1b2N5x5,im1b3N5x5) (3) + +could represent a high pass filter (Note that by implying three neighborhoods, the operator mean returns a row vector of three components. +It is a typical behaviour for many operators of this application). + + +- Operators: + +In addition to the previous operators, other operators are available: +- existing operators/functions from muParserX, that were not originally defined for vectors and +matrices (for instance cos, sin, ...). These new operators/ functions keep the original names to which we added the prefix 'v' for vector (vcos, vsin, ...). +- mult, div and pow operators, that perform element-wise multiplication, division or exponentiation of vector/matrices (for instance im1 div im2) +- mlt, dv and pw operators, that perform multiplication, division or exponentiation of vector/matrices by a scalar (for instance im1 dv 2.0) +- bands, which is a very usefull operator. It allows to select specific bands from an image, and/or to rearrange them in a new vector; +for instance bands(im1,{1,2,1,1}) produces a vector of 4 components made of band 1, band 2, band 1 and band 1 values from the first input. +Note that curly brackets must be used in order to select the desired band indices. +... and so on. + + +- Application itself: + +The application takes the following parameters : +- Setting the list of inputs can be done with the 'il' parameter. +- Setting expressions can be done with the 'exp' parameter (see also limitations section below). +- Setting constants can be done with the 'incontext' parameter. User must provide a txt file with a specific syntax: #type name value +An example of such a file is given below: + +#F expo 1.1 +#M kernel1 { 0.1 , 0.2 , 0.3; 0.4 , 0.5 , 0.6; 0.7 , 0.8 , 0.9; 1 , 1.1 , 1.2; 1.3 , 1.4 , 1.5 } + +As we can see, #I/#F allows the definition of an integer/float constant, whereas #M allows the definition of a vector/matrix. +In the latter case, elements of a row must be separated by commas, and rows must be separated by semicolons. +It is also possible to define expressions within the same txt file, with the pattern #E expr. For instance (two expressions; see also limitations section below): + +#E $dotpr(kernel1,im1b1N3x5); im2b1^expo$ + +- The 'outcontext' parameter allows to save user's constants and expressions (context). +- Setting the output image can be done with the 'out' parameter (multi-outputs is not implemented yet). + + +Finally, we strongly recommend that the reader takes a look at the cookbook, where additional information can be found (http://www.orfeo-toolbox.org/packages/OTBCookBook.pdf). +

Parameters

  • [param] -il <string> Image list to perform computation on.. Mandatory: True. Default Value: "0"
  • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
  • [param] -exp <string> Mathematical expression to apply.. Mandatory: False. Default Value: ""
  • [param] -incontext <string> A txt file containing user's constants and expressions.. Mandatory: False. Default Value: ""
  • [param] -outcontext <string> A txt file where to save user's constants and expressions.. Mandatory: False. Default Value: ""
  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

Limitations

The application is currently unable to produce one output image per expression, contrary to otbBandMathXImageFilter. +Separating expressions by semi-colons (; ) will concatenate their results into a unique multiband output image.

Authors

OTB-Team

See Also

Example of use

  • il: verySmallFSATSW_r.tif verySmallFSATSW_nir.tif verySmallFSATSW.tif

  • out: apTvUtBandMathOutput.tif

  • exp: "cos(im1b1)+im2b1*im3b1-im3b2+ndvi(im3b3, im3b4)"

\ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-closing.html b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-closing.html index f0147996c38..97a2b19d706 100644 --- a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-closing.html +++ b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-closing.html @@ -2,4 +2,4 @@ -

BinaryMorphologicalOperation

Brief Description

Performs morphological operations on an input image channel

Tags

MorphologicalOperations,Feature Extraction

Long Description

This application performs binary morphological operations on a mono band image

Parameters

  • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
  • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
  • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
    • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
    • [group] -ball
      • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
      • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
    • [group] -cross
      [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
      • [group] -dilate
        • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
        • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
      • [group] -erode
        • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
        • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
      • [group] -opening
        • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
        • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
      • [group] -closing
        • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

    Limitations

    None

    Authors

    OTB-Team

    See Also

    itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

    Example of use

    • in: qb_RoadExtract.tif

    • out: opened.tif

    • channel: 1

    • structype.ball.xradius: 5

    • structype.ball.yradius: 5

    • filter: erode

    \ No newline at end of file +

    BinaryMorphologicalOperation

    Brief Description

    Performs morphological operations on an input image channel

    Tags

    MorphologicalOperations,Feature Extraction

    Long Description

    This application performs binary morphological operations on a mono band image

    Parameters

    • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
    • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
      • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
      • [group] -ball
        • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
        • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
      • [group] -cross
        [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
        • [group] -dilate
          • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
          • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
        • [group] -erode
          • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
          • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
        • [group] -opening
          • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
          • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
        • [group] -closing
          • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

      Limitations

      None

      Authors

      OTB-Team

      See Also

      itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

      Example of use

      • in: qb_RoadExtract.tif

      • out: opened.tif

      • channel: 1

      • structype.ball.xradius: 5

      • structype.ball.yradius: 5

      • filter: erode

      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-dilate.html b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-dilate.html index f0147996c38..97a2b19d706 100644 --- a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-dilate.html +++ b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-dilate.html @@ -2,4 +2,4 @@ -

      BinaryMorphologicalOperation

      Brief Description

      Performs morphological operations on an input image channel

      Tags

      MorphologicalOperations,Feature Extraction

      Long Description

      This application performs binary morphological operations on a mono band image

      Parameters

      • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
      • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
      • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
        • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
        • [group] -ball
          • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
          • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
        • [group] -cross
          [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
          • [group] -dilate
            • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
            • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
          • [group] -erode
            • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
            • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
          • [group] -opening
            • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
            • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
          • [group] -closing
            • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

        Limitations

        None

        Authors

        OTB-Team

        See Also

        itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

        Example of use

        • in: qb_RoadExtract.tif

        • out: opened.tif

        • channel: 1

        • structype.ball.xradius: 5

        • structype.ball.yradius: 5

        • filter: erode

        \ No newline at end of file +

        BinaryMorphologicalOperation

        Brief Description

        Performs morphological operations on an input image channel

        Tags

        MorphologicalOperations,Feature Extraction

        Long Description

        This application performs binary morphological operations on a mono band image

        Parameters

        • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
        • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
        • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
          • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
          • [group] -ball
            • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
            • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
          • [group] -cross
            [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
            • [group] -dilate
              • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
              • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
            • [group] -erode
              • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
              • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
            • [group] -opening
              • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
              • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
            • [group] -closing
              • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

          Limitations

          None

          Authors

          OTB-Team

          See Also

          itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

          Example of use

          • in: qb_RoadExtract.tif

          • out: opened.tif

          • channel: 1

          • structype.ball.xradius: 5

          • structype.ball.yradius: 5

          • filter: erode

          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-erode.html b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-erode.html index f0147996c38..97a2b19d706 100644 --- a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-erode.html +++ b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-erode.html @@ -2,4 +2,4 @@ -

          BinaryMorphologicalOperation

          Brief Description

          Performs morphological operations on an input image channel

          Tags

          MorphologicalOperations,Feature Extraction

          Long Description

          This application performs binary morphological operations on a mono band image

          Parameters

          • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
          • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
          • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
          • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
            • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
            • [group] -ball
              • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
              • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
            • [group] -cross
              [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
              • [group] -dilate
                • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
              • [group] -erode
                • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
              • [group] -opening
                • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
              • [group] -closing
                • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

            Limitations

            None

            Authors

            OTB-Team

            See Also

            itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

            Example of use

            • in: qb_RoadExtract.tif

            • out: opened.tif

            • channel: 1

            • structype.ball.xradius: 5

            • structype.ball.yradius: 5

            • filter: erode

            \ No newline at end of file +

            BinaryMorphologicalOperation

            Brief Description

            Performs morphological operations on an input image channel

            Tags

            MorphologicalOperations,Feature Extraction

            Long Description

            This application performs binary morphological operations on a mono band image

            Parameters

            • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
            • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
              • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
              • [group] -ball
                • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
              • [group] -cross
                [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                • [group] -dilate
                  • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                  • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                • [group] -erode
                  • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                  • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                • [group] -opening
                  • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                  • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                • [group] -closing
                  • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

              Limitations

              None

              Authors

              OTB-Team

              See Also

              itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

              Example of use

              • in: qb_RoadExtract.tif

              • out: opened.tif

              • channel: 1

              • structype.ball.xradius: 5

              • structype.ball.yradius: 5

              • filter: erode

              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-opening.html b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-opening.html index f0147996c38..97a2b19d706 100644 --- a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-opening.html +++ b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation-opening.html @@ -2,4 +2,4 @@ -

              BinaryMorphologicalOperation

              Brief Description

              Performs morphological operations on an input image channel

              Tags

              MorphologicalOperations,Feature Extraction

              Long Description

              This application performs binary morphological operations on a mono band image

              Parameters

              • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
              • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
              • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                • [group] -ball
                  • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                  • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                • [group] -cross
                  [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                  • [group] -dilate
                    • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                    • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                  • [group] -erode
                    • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                    • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                  • [group] -opening
                    • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                    • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                  • [group] -closing
                    • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

                Limitations

                None

                Authors

                OTB-Team

                See Also

                itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

                Example of use

                • in: qb_RoadExtract.tif

                • out: opened.tif

                • channel: 1

                • structype.ball.xradius: 5

                • structype.ball.yradius: 5

                • filter: erode

                \ No newline at end of file +

                BinaryMorphologicalOperation

                Brief Description

                Performs morphological operations on an input image channel

                Tags

                MorphologicalOperations,Feature Extraction

                Long Description

                This application performs binary morphological operations on a mono band image

                Parameters

                • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                  • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                  • [group] -ball
                    • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                    • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                  • [group] -cross
                    [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                    • [group] -dilate
                      • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                      • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                    • [group] -erode
                      • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                      • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                    • [group] -opening
                      • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                      • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                    • [group] -closing
                      • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

                  Limitations

                  None

                  Authors

                  OTB-Team

                  See Also

                  itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

                  Example of use

                  • in: qb_RoadExtract.tif

                  • out: opened.tif

                  • channel: 1

                  • structype.ball.xradius: 5

                  • structype.ball.yradius: 5

                  • filter: erode

                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation.html b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation.html index f0147996c38..97a2b19d706 100644 --- a/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation.html +++ b/python/plugins/processing/algs/otb/description/doc/BinaryMorphologicalOperation.html @@ -2,4 +2,4 @@ -

                  BinaryMorphologicalOperation

                  Brief Description

                  Performs morphological operations on an input image channel

                  Tags

                  MorphologicalOperations,Feature Extraction

                  Long Description

                  This application performs binary morphological operations on a mono band image

                  Parameters

                  • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                  • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                  • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                    • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                    • [group] -ball
                      • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                      • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                    • [group] -cross
                      [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                      • [group] -dilate
                        • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                        • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                      • [group] -erode
                        • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                        • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                      • [group] -opening
                        • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                        • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                      • [group] -closing
                        • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

                    Limitations

                    None

                    Authors

                    OTB-Team

                    See Also

                    itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

                    Example of use

                    • in: qb_RoadExtract.tif

                    • out: opened.tif

                    • channel: 1

                    • structype.ball.xradius: 5

                    • structype.ball.yradius: 5

                    • filter: erode

                    \ No newline at end of file +

                    BinaryMorphologicalOperation

                    Brief Description

                    Performs morphological operations on an input image channel

                    Tags

                    MorphologicalOperations,Feature Extraction

                    Long Description

                    This application performs binary morphological operations on a mono band image

                    Parameters

                    • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                    • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                      • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                      • [group] -ball
                        • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                        • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                      • [group] -cross
                        [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                        • [group] -dilate
                          • [param] -filter.dilate.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                          • [param] -filter.dilate.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                        • [group] -erode
                          • [param] -filter.erode.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                          • [param] -filter.erode.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                        • [group] -opening
                          • [param] -filter.opening.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"
                          • [param] -filter.opening.backval <float> The Background Value. Mandatory: True. Default Value: "0"
                        • [group] -closing
                          • [param] -filter.closing.foreval <float> The Foreground Value. Mandatory: True. Default Value: "1"

                      Limitations

                      None

                      Authors

                      OTB-Team

                      See Also

                      itkBinaryDilateImageFilter, itkBinaryErodeImageFilter, itkBinaryMorphologicalOpeningImageFilter and itkBinaryMorphologicalClosingImageFilter classes

                      Example of use

                      • in: qb_RoadExtract.tif

                      • out: opened.tif

                      • channel: 1

                      • structype.ball.xradius: 5

                      • structype.ball.yradius: 5

                      • filter: erode

                      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BlockMatching.html b/python/plugins/processing/algs/otb/description/doc/BlockMatching.html index eaa4ce0b8ce..beab4c95290 100644 --- a/python/plugins/processing/algs/otb/description/doc/BlockMatching.html +++ b/python/plugins/processing/algs/otb/description/doc/BlockMatching.html @@ -2,4 +2,4 @@ -

                      BlockMatching

                      Brief Description

                      Performs block-matching to estimate pixel-wise disparities between two images

                      Tags

                      Stereo

                      Long Description

                      This application allows performing block-matching to estimate pixel-wise disparities between two images. The application allows choosing the block-matching method to use. It also allows inputting masks (related to the left and right input image) of pixels for which the disparity should be investigated. Additionally, two criteria can be optionally used to disable disparity investigation for some pixel: a no-data value, and a threshold on the local variance. This allows speeding up computation by avoiding to investigate disparities that will not be reliable anyway. For efficiency reasons, if the optimal metric values image is desired, it will be concatenated to the output image (which will then have three bands : horizontal disparity, vertical disparity and metric value). One can split these images afterward.

                      Parameters

                      • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                      • [param] -mask <string> This group of parameters allows determining the masking parameters to prevent disparities estimation for some pixels of the left image. Mandatory: True. Default Value: "0"
                      • [param] -bm <string> This group of parameters allow to tune the block-matching behaviour. Mandatory: True. Default Value: "0"
                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                      Limitations

                      None

                      Authors

                      OTB-Team

                      See Also

                      otbStereoRectificationGridGenerator

                      Example of use

                      • io.inleft: StereoFixed.png

                      • io.inright: StereoMoving.png

                      • bm.minhd: -10

                      • bm.maxhd: 10

                      • mask.variancet: 10

                      • io.out: MyDisparity.tif

                      \ No newline at end of file +

                      BlockMatching

                      Brief Description

                      Performs block-matching to estimate pixel-wise disparities between two images

                      Tags

                      Stereo

                      Long Description

                      This application allows to performs block-matching to estimate pixel-wise disparities between two images. The application allows to choose the block-matching method to use. It also allows to input masks (related to the left and right input image) of pixels for which the disparity should be investigated. Additionally, two criteria can be optionally used to disable disparity investigation for some pixel: a no-data value, and a threshold on the local variance. This allows to speed-up computation by avoiding to investigate disparities that will not be reliable anyway. For efficiency reasons, if the optimal metric values image is desired, it will be concatenated to the output image (which will then have three bands : horizontal disparity, vertical disparity and metric value). One can split these images afterward.

                      Parameters

                      • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                      • [param] -mask <string> This group of parameters allows to determine the masking parameters to prevent disparities estimation for some pixels of the left image. Mandatory: True. Default Value: "0"
                      • [param] -bm <string> This group of parameters allow to tune the block-matching behaviour. Mandatory: True. Default Value: "0"
                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                      Limitations

                      None

                      Authors

                      OTB-Team

                      See Also

                      otbStereoRectificationGridGenerator

                      Example of use

                      • io.inleft: StereoFixed.png

                      • io.inright: StereoMoving.png

                      • bm.minhd: -10

                      • bm.maxhd: 10

                      • mask.variancet: 10

                      • io.out: MyDisparity.tif

                      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/BundleToPerfectSensor.html b/python/plugins/processing/algs/otb/description/doc/BundleToPerfectSensor.html index eab4375d72d..67e602eb242 100644 --- a/python/plugins/processing/algs/otb/description/doc/BundleToPerfectSensor.html +++ b/python/plugins/processing/algs/otb/description/doc/BundleToPerfectSensor.html @@ -2,4 +2,4 @@ -

                      BundleToPerfectSensor

                      Brief Description

                      Perform P+XS pansharpening

                      Tags

                      Geometry,Pansharpening

                      Long Description

                      This application performs P+XS pansharpening.

                      Parameters

                      • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                      • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                      • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                      • [param] -lms <float> Spacing of the deformation field. Default is 10 times the PAN image spacing.. Mandatory: False. Default Value: "0.0"
                      • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                      Limitations

                      None

                      Authors

                      OTB-Team

                      See Also

                      Example of use

                      • inp: QB_Toulouse_Ortho_PAN.tif

                      • inxs: QB_Toulouse_Ortho_XS.tif

                      • out: BundleToPerfectSensor.png uchar

                      \ No newline at end of file +

                      BundleToPerfectSensor

                      Brief Description

                      Perform P+XS pansharpening

                      Tags

                      Geometry,Pansharpening

                      Long Description

                      This application performs P+XS pansharpening. The default mode use Pan and XS sensor models to estimate the transformation to superimpose XS over Pan before the fusion ("default mode"). The application provides also a PHR mode for Pleiades images which does not use sensor models as Pan and XS products are already coregistered but only estimate an affine transformation to superimpose XS over the Pan.Note that this option is automatically activated in case Pleiades images are detected as input.

                      Parameters

                      • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                      • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                      • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                      • [param] -lms <float> Spacing of the deformation field. Default is 10 times the PAN image spacing.. Mandatory: False. Default Value: "0.0"
                      • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                        • [choice] -mode Superimposition mode default,phr. Mandatory: True. Default Value: "default"
                        • [group] -default
                          • [param] -elev.default <float> 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.. Mandatory: True. Default Value: "0"
                        • [group] -phr

                        Limitations

                        None

                        Authors

                        OTB-Team

                        See Also

                        Example of use

                        • inp: QB_Toulouse_Ortho_PAN.tif

                        • inxs: QB_Toulouse_Ortho_XS.tif

                        • out: BundleToPerfectSensor.png uchar

                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ClassificationMapRegularization.html b/python/plugins/processing/algs/otb/description/doc/ClassificationMapRegularization.html index 9737542358b..bc67a5f30f7 100644 --- a/python/plugins/processing/algs/otb/description/doc/ClassificationMapRegularization.html +++ b/python/plugins/processing/algs/otb/description/doc/ClassificationMapRegularization.html @@ -2,6 +2,6 @@ -

                        ClassificationMapRegularization

                        Brief Description

                        Filters the input labeled image using Majority Voting in a ball shaped neighborhood.

                        Tags

                        Learning,Image Analysis

                        Long Description

                        This application filters the input labeled image using Majority Voting in a ball shaped neighborhood. Majority Voting takes the more representative value of all the pixels identified by the ball shaped structuring element and then sets the center pixel to this majority label value. +

                        ClassificationMapRegularization

                        Brief Description

                        Filters the input labeled image using Majority Voting in a ball shaped neighbordhood.

                        Tags

                        Learning,Image Analysis

                        Long Description

                        This application filters the input labeled image (with a maximal class label = 65535) using Majority Voting in a ball shaped neighbordhood. Majority Voting takes the more representative value of all the pixels identified by the ball shaped structuring element and then sets the center pixel to this majority label value. -NoData is the label of the NOT classified pixels in the input image. These input pixels keep their NoData label in the output image. - -Pixels with more than 1 majority class are marked as Undecided if the parameter 'ip.suvbool == true', or keep their Original labels otherwise.

                        Parameters

                        • [param] -io <string> This group of parameters allows setting input and output images for classification map regularization by Majority Voting.. Mandatory: True. Default Value: "0"
                        • [param] -ip <string> This group allows setting parameters for classification map regularization by Majority Voting.. Mandatory: True. Default Value: "0"
                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                        Limitations

                        The input image must be a single band labeled image. The structuring element radius must have a minimum value equal to 1 pixel. Please note that the Undecided value must be different from existing labels in the input labeled image.

                        Authors

                        OTB-Team

                        See Also

                        Documentation of the ClassificationMapRegularization application.

                        Example of use

                        • io.in: clLabeledImageQB123_1.tif

                        • io.out: clLabeledImageQB123_1_CMR_r2_nodl_10_undl_7.tif

                        • ip.radius: 2

                        • ip.suvbool: true

                        • ip.nodatalabel: 10

                        • ip.undecidedlabel: 7

                        + -Pixels with more than 1 majority class are marked as Undecided if the parameter 'ip.suvbool == true', or keep their Original labels otherwise.

                        Parameters

                        • [param] -io <string> This group of parameters allows to set input and output images for classification map regularization by Majority Voting.. Mandatory: True. Default Value: "0"
                        • [param] -ip <string> This group allows to set parameters for classification map regularization by Majority Voting.. Mandatory: True. Default Value: "0"
                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                        Limitations

                        The input image must be a single band labeled image (with a maximal class label = 65535). The structuring element radius must have a minimum value equal to 1 pixel. Please note that the Undecided value must be different from existing labels in the input labeled image.

                        Authors

                        OTB-Team

                        See Also

                        Documentation of the ClassificationMapRegularization application.

                        Example of use

                        • io.in: clLabeledImageQB123_1.tif

                        • io.out: clLabeledImageQB123_1_CMR_r2_nodl_10_undl_7.tif

                        • ip.radius: 2

                        • ip.suvbool: true

                        • ip.nodatalabel: 10

                        • ip.undecidedlabel: 7

                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ColorMapping-continuous.html b/python/plugins/processing/algs/otb/description/doc/ColorMapping-continuous.html index 5cd5b3cb2d9..3002e310c13 100644 --- a/python/plugins/processing/algs/otb/description/doc/ColorMapping-continuous.html +++ b/python/plugins/processing/algs/otb/description/doc/ColorMapping-continuous.html @@ -2,12 +2,12 @@ -

                        ColorMapping

                        Brief Description

                        Maps an input label image to 8-bits RGB using look-up tables.

                        Tags

                        Utilities,Image Manipulation,Image MetaData,Learning

                        Long Description

                        This application allows mapping a label image to a 8-bits RGB image (in both ways) using different methods. - -The custom method allows using a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. - -The continuous method allows mapping a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. +

                        ColorMapping

                        Brief Description

                        Maps an input label image to 8-bits RGB using look-up tables.

                        Tags

                        Utilities,Image Manipulation,Image MetaData,Learning

                        Long Description

                        This application allows to map a label image to a 8-bits RGB image (in both ways) using different methods. + -The custom method allows to use a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. + -The continuous method allows to map a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. -The optimal method computes an optimal look-up table. When processing a segmentation label image (label to color), the color difference between adjacent segmented regions is maximized. When processing an unknown color image (color to label), all the present colors are mapped to a continuous label list. - - The support image method uses a color support image to associate an average color to each region.

                        Parameters

                        • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                        • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                          • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                          • [group] -labeltocolor
                            • [group] -colortolabel
                              • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                            [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                            • [group] -custom
                              • [param] -method.custom.lut <string> An ASCII file containing the look-up table + - The support image method uses a color support image to associate an average color to each region.

                                Parameters

                                • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                  • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                  • [group] -labeltocolor
                                    • [group] -colortolabel
                                      • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                    [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                    • [group] -custom
                                      • [param] -method.custom.lut <string> An ASCII file containing the look-up table with one color per line (for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0) -Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                    • [group] -continuous
                                      • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                      • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                      • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                    • [group] -optimal
                                      • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                    • [group] -image
                                      • [param] -method.image.in <string> Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                      • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                      • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                  Limitations

                                  The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. +Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                              • [group] -continuous
                                • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                              • [group] -optimal
                                • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                              • [group] -image
                                • [param] -method.image.in <string> Support image filename. For each label, the LUT is calculated from the mean pixel value in the support image, over the corresponding labeled areas. First of all, the support image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                • [param] -method.image.nodatavalue <float> NoData value for each channel of the support image, which will not be handled in the LUT estimation. If NOT checked, ALL the pixel values of the support image will be handled in the LUT estimation.. Mandatory: False. Default Value: "0"
                                • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                            Limitations

                            The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. ColorMapping using support image is not threaded.

                            Authors

                            OTB-Team

                            See Also

                            ImageSVMClassifier

                            Example of use

                            • in: ROI_QB_MUL_1_SVN_CLASS_MULTI.png

                            • method: custom

                            • method.custom.lut: ROI_QB_MUL_1_SVN_CLASS_MULTI_PNG_ColorTable.txt

                            • out: Colorized_ROI_QB_MUL_1_SVN_CLASS_MULTI.tif

                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ColorMapping-custom.html b/python/plugins/processing/algs/otb/description/doc/ColorMapping-custom.html index 5cd5b3cb2d9..3002e310c13 100644 --- a/python/plugins/processing/algs/otb/description/doc/ColorMapping-custom.html +++ b/python/plugins/processing/algs/otb/description/doc/ColorMapping-custom.html @@ -2,12 +2,12 @@ -

                            ColorMapping

                            Brief Description

                            Maps an input label image to 8-bits RGB using look-up tables.

                            Tags

                            Utilities,Image Manipulation,Image MetaData,Learning

                            Long Description

                            This application allows mapping a label image to a 8-bits RGB image (in both ways) using different methods. - -The custom method allows using a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. - -The continuous method allows mapping a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. +

                            ColorMapping

                            Brief Description

                            Maps an input label image to 8-bits RGB using look-up tables.

                            Tags

                            Utilities,Image Manipulation,Image MetaData,Learning

                            Long Description

                            This application allows to map a label image to a 8-bits RGB image (in both ways) using different methods. + -The custom method allows to use a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. + -The continuous method allows to map a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. -The optimal method computes an optimal look-up table. When processing a segmentation label image (label to color), the color difference between adjacent segmented regions is maximized. When processing an unknown color image (color to label), all the present colors are mapped to a continuous label list. - - The support image method uses a color support image to associate an average color to each region.

                            Parameters

                            • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                            • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                              • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                              • [group] -labeltocolor
                                • [group] -colortolabel
                                  • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                • [group] -custom
                                  • [param] -method.custom.lut <string> An ASCII file containing the look-up table + - The support image method uses a color support image to associate an average color to each region.

                                    Parameters

                                    • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                    • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                      • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                      • [group] -labeltocolor
                                        • [group] -colortolabel
                                          • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                        [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                        • [group] -custom
                                          • [param] -method.custom.lut <string> An ASCII file containing the look-up table with one color per line (for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0) -Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                        • [group] -continuous
                                          • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                          • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                          • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                        • [group] -optimal
                                          • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                        • [group] -image
                                          • [param] -method.image.in <string> Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                          • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                          • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                      Limitations

                                      The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. +Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                  • [group] -continuous
                                    • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                    • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                    • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                  • [group] -optimal
                                    • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                  • [group] -image
                                    • [param] -method.image.in <string> Support image filename. For each label, the LUT is calculated from the mean pixel value in the support image, over the corresponding labeled areas. First of all, the support image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                    • [param] -method.image.nodatavalue <float> NoData value for each channel of the support image, which will not be handled in the LUT estimation. If NOT checked, ALL the pixel values of the support image will be handled in the LUT estimation.. Mandatory: False. Default Value: "0"
                                    • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                    • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                Limitations

                                The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. ColorMapping using support image is not threaded.

                                Authors

                                OTB-Team

                                See Also

                                ImageSVMClassifier

                                Example of use

                                • in: ROI_QB_MUL_1_SVN_CLASS_MULTI.png

                                • method: custom

                                • method.custom.lut: ROI_QB_MUL_1_SVN_CLASS_MULTI_PNG_ColorTable.txt

                                • out: Colorized_ROI_QB_MUL_1_SVN_CLASS_MULTI.tif

                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ColorMapping-image.html b/python/plugins/processing/algs/otb/description/doc/ColorMapping-image.html index 5cd5b3cb2d9..3002e310c13 100644 --- a/python/plugins/processing/algs/otb/description/doc/ColorMapping-image.html +++ b/python/plugins/processing/algs/otb/description/doc/ColorMapping-image.html @@ -2,12 +2,12 @@ -

                                ColorMapping

                                Brief Description

                                Maps an input label image to 8-bits RGB using look-up tables.

                                Tags

                                Utilities,Image Manipulation,Image MetaData,Learning

                                Long Description

                                This application allows mapping a label image to a 8-bits RGB image (in both ways) using different methods. - -The custom method allows using a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. - -The continuous method allows mapping a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. +

                                ColorMapping

                                Brief Description

                                Maps an input label image to 8-bits RGB using look-up tables.

                                Tags

                                Utilities,Image Manipulation,Image MetaData,Learning

                                Long Description

                                This application allows to map a label image to a 8-bits RGB image (in both ways) using different methods. + -The custom method allows to use a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. + -The continuous method allows to map a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. -The optimal method computes an optimal look-up table. When processing a segmentation label image (label to color), the color difference between adjacent segmented regions is maximized. When processing an unknown color image (color to label), all the present colors are mapped to a continuous label list. - - The support image method uses a color support image to associate an average color to each region.

                                Parameters

                                • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                  • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                  • [group] -labeltocolor
                                    • [group] -colortolabel
                                      • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                    [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                    • [group] -custom
                                      • [param] -method.custom.lut <string> An ASCII file containing the look-up table + - The support image method uses a color support image to associate an average color to each region.

                                        Parameters

                                        • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                        • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                          • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                          • [group] -labeltocolor
                                            • [group] -colortolabel
                                              • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                            [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                            • [group] -custom
                                              • [param] -method.custom.lut <string> An ASCII file containing the look-up table with one color per line (for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0) -Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                            • [group] -continuous
                                              • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                              • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                              • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                            • [group] -optimal
                                              • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                            • [group] -image
                                              • [param] -method.image.in <string> Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                              • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                              • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                          Limitations

                                          The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. +Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                      • [group] -continuous
                                        • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                        • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                        • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                      • [group] -optimal
                                        • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                      • [group] -image
                                        • [param] -method.image.in <string> Support image filename. For each label, the LUT is calculated from the mean pixel value in the support image, over the corresponding labeled areas. First of all, the support image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                        • [param] -method.image.nodatavalue <float> NoData value for each channel of the support image, which will not be handled in the LUT estimation. If NOT checked, ALL the pixel values of the support image will be handled in the LUT estimation.. Mandatory: False. Default Value: "0"
                                        • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                        • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                    Limitations

                                    The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. ColorMapping using support image is not threaded.

                                    Authors

                                    OTB-Team

                                    See Also

                                    ImageSVMClassifier

                                    Example of use

                                    • in: ROI_QB_MUL_1_SVN_CLASS_MULTI.png

                                    • method: custom

                                    • method.custom.lut: ROI_QB_MUL_1_SVN_CLASS_MULTI_PNG_ColorTable.txt

                                    • out: Colorized_ROI_QB_MUL_1_SVN_CLASS_MULTI.tif

                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ColorMapping-optimal.html b/python/plugins/processing/algs/otb/description/doc/ColorMapping-optimal.html index 5cd5b3cb2d9..3002e310c13 100644 --- a/python/plugins/processing/algs/otb/description/doc/ColorMapping-optimal.html +++ b/python/plugins/processing/algs/otb/description/doc/ColorMapping-optimal.html @@ -2,12 +2,12 @@ -

                                    ColorMapping

                                    Brief Description

                                    Maps an input label image to 8-bits RGB using look-up tables.

                                    Tags

                                    Utilities,Image Manipulation,Image MetaData,Learning

                                    Long Description

                                    This application allows mapping a label image to a 8-bits RGB image (in both ways) using different methods. - -The custom method allows using a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. - -The continuous method allows mapping a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. +

                                    ColorMapping

                                    Brief Description

                                    Maps an input label image to 8-bits RGB using look-up tables.

                                    Tags

                                    Utilities,Image Manipulation,Image MetaData,Learning

                                    Long Description

                                    This application allows to map a label image to a 8-bits RGB image (in both ways) using different methods. + -The custom method allows to use a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. + -The continuous method allows to map a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. -The optimal method computes an optimal look-up table. When processing a segmentation label image (label to color), the color difference between adjacent segmented regions is maximized. When processing an unknown color image (color to label), all the present colors are mapped to a continuous label list. - - The support image method uses a color support image to associate an average color to each region.

                                    Parameters

                                    • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                    • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                      • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                      • [group] -labeltocolor
                                        • [group] -colortolabel
                                          • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                        [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                        • [group] -custom
                                          • [param] -method.custom.lut <string> An ASCII file containing the look-up table + - The support image method uses a color support image to associate an average color to each region.

                                            Parameters

                                            • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                              • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                              • [group] -labeltocolor
                                                • [group] -colortolabel
                                                  • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                                [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                                • [group] -custom
                                                  • [param] -method.custom.lut <string> An ASCII file containing the look-up table with one color per line (for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0) -Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                                • [group] -continuous
                                                  • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                                  • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                                  • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                                • [group] -optimal
                                                  • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                                • [group] -image
                                                  • [param] -method.image.in <string> Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                                  • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                                  • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                              Limitations

                                              The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. +Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                          • [group] -continuous
                                            • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                            • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                            • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                          • [group] -optimal
                                            • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                          • [group] -image
                                            • [param] -method.image.in <string> Support image filename. For each label, the LUT is calculated from the mean pixel value in the support image, over the corresponding labeled areas. First of all, the support image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                            • [param] -method.image.nodatavalue <float> NoData value for each channel of the support image, which will not be handled in the LUT estimation. If NOT checked, ALL the pixel values of the support image will be handled in the LUT estimation.. Mandatory: False. Default Value: "0"
                                            • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                            • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                        Limitations

                                        The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. ColorMapping using support image is not threaded.

                                        Authors

                                        OTB-Team

                                        See Also

                                        ImageSVMClassifier

                                        Example of use

                                        • in: ROI_QB_MUL_1_SVN_CLASS_MULTI.png

                                        • method: custom

                                        • method.custom.lut: ROI_QB_MUL_1_SVN_CLASS_MULTI_PNG_ColorTable.txt

                                        • out: Colorized_ROI_QB_MUL_1_SVN_CLASS_MULTI.tif

                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ColorMapping.html b/python/plugins/processing/algs/otb/description/doc/ColorMapping.html index 5cd5b3cb2d9..3002e310c13 100644 --- a/python/plugins/processing/algs/otb/description/doc/ColorMapping.html +++ b/python/plugins/processing/algs/otb/description/doc/ColorMapping.html @@ -2,12 +2,12 @@ -

                                        ColorMapping

                                        Brief Description

                                        Maps an input label image to 8-bits RGB using look-up tables.

                                        Tags

                                        Utilities,Image Manipulation,Image MetaData,Learning

                                        Long Description

                                        This application allows mapping a label image to a 8-bits RGB image (in both ways) using different methods. - -The custom method allows using a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. - -The continuous method allows mapping a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. +

                                        ColorMapping

                                        Brief Description

                                        Maps an input label image to 8-bits RGB using look-up tables.

                                        Tags

                                        Utilities,Image Manipulation,Image MetaData,Learning

                                        Long Description

                                        This application allows to map a label image to a 8-bits RGB image (in both ways) using different methods. + -The custom method allows to use a custom look-up table. The look-up table is loaded from a text file where each line describes an entry. The typical use of this method is to colorise a classification map. + -The continuous method allows to map a range of values in a scalar input image to a colored image using continuous look-up table, in order to enhance image interpretation. Several look-up tables can been chosen with different color ranges. -The optimal method computes an optimal look-up table. When processing a segmentation label image (label to color), the color difference between adjacent segmented regions is maximized. When processing an unknown color image (color to label), all the present colors are mapped to a continuous label list. - - The support image method uses a color support image to associate an average color to each region.

                                        Parameters

                                        • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                        • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                          • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                          • [group] -labeltocolor
                                            • [group] -colortolabel
                                              • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                            [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                            • [group] -custom
                                              • [param] -method.custom.lut <string> An ASCII file containing the look-up table + - The support image method uses a color support image to associate an average color to each region.

                                                Parameters

                                                • [param] -in <string> Input image filename. Mandatory: True. Default Value: ""
                                                • [param] -out <string> Output image filename. Mandatory: True. Default Value: ""
                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                  • [choice] -op Selection of the operation to execute (default is : label to color). labeltocolor,colortolabel. Mandatory: True. Default Value: "labeltocolor"
                                                  • [group] -labeltocolor
                                                    • [group] -colortolabel
                                                      • [param] -op.colortolabel.notfound <int32> Label to use for unknown colors.. Mandatory: False. Default Value: "404"
                                                    [choice] -method Selection of color mapping methods and their parameters. custom,continuous,optimal,image. Mandatory: True. Default Value: "custom"
                                                    • [group] -custom
                                                      • [param] -method.custom.lut <string> An ASCII file containing the look-up table with one color per line (for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0) -Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                                    • [group] -continuous
                                                      • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                                      • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                                      • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                                    • [group] -optimal
                                                      • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                                    • [group] -image
                                                      • [param] -method.image.in <string> Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                                      • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                                      • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                                  Limitations

                                                  The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. +Lines beginning with a # are ignored. Mandatory: True. Default Value: ""
                                              • [group] -continuous
                                                • [param] -method.continuous.lut <string> Available look-up tables.. Mandatory: True. Default Value: "red"
                                                • [param] -method.continuous.min <float> Set the lower input value of the mapping range.. Mandatory: True. Default Value: "0"
                                                • [param] -method.continuous.max <float> Set the higher input value of the mapping range.. Mandatory: True. Default Value: "255"
                                              • [group] -optimal
                                                • [param] -method.optimal.background <int32> Value of the background label. Mandatory: True. Default Value: "0"
                                              • [group] -image
                                                • [param] -method.image.in <string> Support image filename. For each label, the LUT is calculated from the mean pixel value in the support image, over the corresponding labeled areas. First of all, the support image is normalized with extrema rejection. Mandatory: True. Default Value: ""
                                                • [param] -method.image.nodatavalue <float> NoData value for each channel of the support image, which will not be handled in the LUT estimation. If NOT checked, ALL the pixel values of the support image will be handled in the LUT estimation.. Mandatory: False. Default Value: "0"
                                                • [param] -method.image.low <int32> lower quantile for image normalization. Mandatory: False. Default Value: "2"
                                                • [param] -method.image.up <int32> upper quantile for image normalization. Mandatory: False. Default Value: "2"

                                            Limitations

                                            The segmentation optimal method does not support streaming, and thus large images. The operation color to label is not implemented for the methods continuous LUT and support image LUT. ColorMapping using support image is not threaded.

                                            Authors

                                            OTB-Team

                                            See Also

                                            ImageSVMClassifier

                                            Example of use

                                            • in: ROI_QB_MUL_1_SVN_CLASS_MULTI.png

                                            • method: custom

                                            • method.custom.lut: ROI_QB_MUL_1_SVN_CLASS_MULTI_PNG_ColorTable.txt

                                            • out: Colorized_ROI_QB_MUL_1_SVN_CLASS_MULTI.tif

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/CompareImages.html b/python/plugins/processing/algs/otb/description/doc/CompareImages.html index ce92b570b67..89de722c473 100644 --- a/python/plugins/processing/algs/otb/description/doc/CompareImages.html +++ b/python/plugins/processing/algs/otb/description/doc/CompareImages.html @@ -2,4 +2,4 @@ -

                                            CompareImages

                                            Brief Description

                                            Estimator between 2 images.

                                            Tags

                                            Statistics

                                            Long Description

                                            This application computes MSE (Mean Squared Error), MAE (Mean Absolute Error) and PSNR (Peak Signal to Noise Ratio) between the channel of two images (reference and measurement). The user has to set the used channel and can specify a ROI.

                                            Parameters

                                            • [param] -ref <string> . Mandatory: True. Default Value: "0"
                                            • [param] -meas <string> . Mandatory: True. Default Value: "0"
                                            • [param] -roi <string> . Mandatory: True. Default Value: "0"
                                            • [param] -mse <float> Mean Squared Error value. Mandatory: True. Default Value: "0.0"
                                            • [param] -mae <float> Mean Absolute Error value. Mandatory: True. Default Value: "0.0"
                                            • [param] -psnr <float> Peak Signal to Noise Ratio value. Mandatory: True. Default Value: "0.0"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            BandMath application, ImageStatistics

                                            Example of use

                                            • ref.in: GomaApres.png

                                            • ref.channel: 1

                                            • meas.in: GomaAvant.png

                                            • meas.channel: 2

                                            • roi.startx: 20

                                            • roi.starty: 30

                                            • roi.sizex: 150

                                            • roi.sizey: 200

                                            \ No newline at end of file +

                                            CompareImages

                                            Brief Description

                                            Estimator between 2 images.

                                            Tags

                                            Statistics

                                            Long Description

                                            This application computes MSE (Mean Squared Error), MAE (Mean Absolute Error) and PSNR (Peak Signal to Noise Ratio) between the channel of two images (reference and measurement). The user has to set the used channel and can specify a ROI.

                                            Parameters

                                            • [param] -ref <string> . Mandatory: True. Default Value: "0"
                                            • [param] -meas <string> . Mandatory: True. Default Value: "0"
                                            • [param] -roi <string> . Mandatory: True. Default Value: "0"
                                            • [param] -mse <float> Mean Squared Error value. Mandatory: True. Default Value: "0.0"
                                            • [param] -mae <float> Mean Absolute Error value. Mandatory: True. Default Value: "0.0"
                                            • [param] -psnr <float> Peak Signal to Noise Ratio value. Mandatory: True. Default Value: "0.0"
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            BandMath application, ImageStatistics

                                            Example of use

                                            • ref.in: GomaApres.png

                                            • ref.channel: 1

                                            • meas.in: GomaAvant.png

                                            • meas.channel: 2

                                            • roi.startx: 20

                                            • roi.starty: 30

                                            • roi.sizex: 150

                                            • roi.sizey: 200

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-raster.html b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-raster.html index d8299fe437d..8a6c9eed9ad 100644 --- a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-raster.html +++ b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-raster.html @@ -2,4 +2,4 @@ -

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file +

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-vector.html b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-vector.html index d8299fe437d..8a6c9eed9ad 100644 --- a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-vector.html +++ b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix-vector.html @@ -2,4 +2,4 @@ -

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file +

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix.html b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix.html index d8299fe437d..8a6c9eed9ad 100644 --- a/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix.html +++ b/python/plugins/processing/algs/otb/description/doc/ComputeConfusionMatrix.html @@ -2,4 +2,4 @@ -

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file +

                                            ComputeConfusionMatrix

                                            Brief Description

                                            Computes the confusion matrix of a classification

                                            Tags

                                            Learning

                                            Long Description

                                            This application computes the confusion matrix of a classification map relatively to a ground truth. This ground truth can be given as a raster or a vector data. Only reference and produced pixels with values different from NoData are handled in the calculation of the confusion matrix. The confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the output file, the reference and produced class labels are ordered according to the rows/columns of the confusion matrix.

                                            Parameters

                                            • [param] -in <string> The input classification image.. Mandatory: True. Default Value: ""
                                            • [param] -out <string> Filename to store the output matrix (csv format). Mandatory: True. Default Value: ""
                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels will be discarded from the ground truth and from the input classification map. By default, 'nodatalabel = 0'.. Mandatory: False. Default Value: "0"
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                              • [choice] -ref Choice of ground truth format raster,vector. Mandatory: True. Default Value: "raster"
                                              • [group] -raster
                                                • [param] -ref.raster.in <string> Input image containing the ground truth labels. Mandatory: True. Default Value: ""
                                              • [group] -vector
                                                • [param] -ref.vector.in <string> Input vector data of the ground truth. Mandatory: True. Default Value: ""
                                                • [param] -ref.vector.field <string> Field name containing the label values. Mandatory: False. Default Value: "Class"

                                            Limitations

                                            None

                                            Authors

                                            OTB-Team

                                            See Also

                                            Example of use

                                            • in: clLabeledImageQB1.tif

                                            • out: ConfusionMatrix.csv

                                            • ref: vector

                                            • ref.vector.in: VectorData_QB1_bis.shp

                                            • ref.vector.field: Class

                                            • nodatalabel: 255

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeImagesStatistics.html b/python/plugins/processing/algs/otb/description/doc/ComputeImagesStatistics.html index 4cc40bfc5a7..05cb9575bdb 100644 --- a/python/plugins/processing/algs/otb/description/doc/ComputeImagesStatistics.html +++ b/python/plugins/processing/algs/otb/description/doc/ComputeImagesStatistics.html @@ -2,4 +2,4 @@ -

                                            ComputeImagesStatistics

                                            Brief Description

                                            Computes global mean and standard deviation for each band from a set of images and optionally saves the results in an XML file.

                                            Tags

                                            Learning,Image Analysis

                                            Long Description

                                            This application computes a global mean and standard deviation for each band of a set of images and optionally saves the results in an XML file. The output XML is intended to be used an input for the TrainImagesClassifier application to normalize samples before learning.

                                            Parameters

                                            • [param] -il <string> List of input images filenames.. Mandatory: True. Default Value: "0"
                                            • [param] -bv <float> Background value to ignore in statistics computation.. Mandatory: False. Default Value: "0.0"
                                            • [param] -out <string> XML filename where the statistics are saved for future reuse.. Mandatory: False. Default Value: ""

                                            Limitations

                                            Each image of the set must contain the same bands as the others (i.e. same types, in the same order).

                                            Authors

                                            OTB-Team

                                            See Also

                                            Documentation of the TrainImagesClassifier application.

                                            Example of use

                                            • il: QB_1_ortho.tif

                                            • out: EstimateImageStatisticsQB1.xml

                                            \ No newline at end of file +

                                            ComputeImagesStatistics

                                            Brief Description

                                            Computes global mean and standard deviation for each band from a set of images and optionally saves the results in an XML file.

                                            Tags

                                            Learning,Image Analysis

                                            Long Description

                                            This application computes a global mean and standard deviation for each band of a set of images and optionally saves the results in an XML file. The output XML is intended to be used an input for the TrainImagesClassifier application to normalize samples before learning.

                                            Parameters

                                            • [param] -il <string> List of input images filenames.. Mandatory: True. Default Value: "0"
                                            • [param] -bv <float> Background value to ignore in statistics computation.. Mandatory: False. Default Value: "0.0"
                                            • [param] -out <string> XML filename where the statistics are saved for future reuse.. Mandatory: False. Default Value: ""
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                            Limitations

                                            Each image of the set must contain the same bands as the others (i.e. same types, in the same order).

                                            Authors

                                            OTB-Team

                                            See Also

                                            Documentation of the TrainImagesClassifier application.

                                            Example of use

                                            • il: QB_1_ortho.tif

                                            • out: EstimateImageStatisticsQB1.xml

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-OneEntry.html b/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-OneEntry.html deleted file mode 100644 index bb861bd888a..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-OneEntry.html +++ /dev/null @@ -1,5 +0,0 @@ - - -

                                            ComputeModulusAndPhase

                                            Brief Description

                                            Read one or two files and compute the module and the phase

                                            Tags

                                            SAR

                                            Long Description

                                            This application computes the modulus and the phase of a complex SAR data. This complex SAR data could be provided as a monoband complex pixel type image or a 2 bands real pixel type image or two monobands (first one real part and second one imaginary part) real pixel type images.

                                            Parameters

                                            • [param] -mod <string> Modulus of the input: sqrt(real*real + imag*imag).. Mandatory: True. Default Value: ""
                                            • [param] -pha <string> Phase of the input: atan2(imag, real).. Mandatory: True. Default Value: ""
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -nbinput Choice about the number of input files used to store the real and imaginary part of the SAR image one,two. Mandatory: True. Default Value: "one"
                                              • [group] -one
                                                • [param] -nbinput.one.in <string> Image file with SAR data.. Mandatory: True. Default Value: ""
                                              • [group] -two
                                                • [param] -nbinput.two.re <string> Image file with real part of the SAR data.. Mandatory: False. Default Value: ""
                                                • [param] -nbinput.two.im <string> Image file with imaginary part of the SAR data.. Mandatory: False. Default Value: ""

                                            Limitations

                                            None

                                            Authors

                                            Alexia Mondot (alexia.mondot@c-s.fr) and Mickael Savinaud (mickael.savinaud@c-s.fr)

                                            See Also

                                            Example of use

                                            • nbinput.one.in: monobandComplexFloat.tif

                                            • mod: modulus.tif

                                            • pha: phase.tif

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-TwoEntries.html b/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-TwoEntries.html deleted file mode 100644 index bb861bd888a..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase-TwoEntries.html +++ /dev/null @@ -1,5 +0,0 @@ - - -

                                            ComputeModulusAndPhase

                                            Brief Description

                                            Read one or two files and compute the module and the phase

                                            Tags

                                            SAR

                                            Long Description

                                            This application computes the modulus and the phase of a complex SAR data. This complex SAR data could be provided as a monoband complex pixel type image or a 2 bands real pixel type image or two monobands (first one real part and second one imaginary part) real pixel type images.

                                            Parameters

                                            • [param] -mod <string> Modulus of the input: sqrt(real*real + imag*imag).. Mandatory: True. Default Value: ""
                                            • [param] -pha <string> Phase of the input: atan2(imag, real).. Mandatory: True. Default Value: ""
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -nbinput Choice about the number of input files used to store the real and imaginary part of the SAR image one,two. Mandatory: True. Default Value: "one"
                                              • [group] -one
                                                • [param] -nbinput.one.in <string> Image file with SAR data.. Mandatory: True. Default Value: ""
                                              • [group] -two
                                                • [param] -nbinput.two.re <string> Image file with real part of the SAR data.. Mandatory: False. Default Value: ""
                                                • [param] -nbinput.two.im <string> Image file with imaginary part of the SAR data.. Mandatory: False. Default Value: ""

                                            Limitations

                                            None

                                            Authors

                                            Alexia Mondot (alexia.mondot@c-s.fr) and Mickael Savinaud (mickael.savinaud@c-s.fr)

                                            See Also

                                            Example of use

                                            • nbinput.one.in: monobandComplexFloat.tif

                                            • mod: modulus.tif

                                            • pha: phase.tif

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase.html b/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase.html deleted file mode 100644 index bb861bd888a..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/ComputeModulusAndPhase.html +++ /dev/null @@ -1,5 +0,0 @@ - - -

                                            ComputeModulusAndPhase

                                            Brief Description

                                            Read one or two files and compute the module and the phase

                                            Tags

                                            SAR

                                            Long Description

                                            This application computes the modulus and the phase of a complex SAR data. This complex SAR data could be provided as a monoband complex pixel type image or a 2 bands real pixel type image or two monobands (first one real part and second one imaginary part) real pixel type images.

                                            Parameters

                                            • [param] -mod <string> Modulus of the input: sqrt(real*real + imag*imag).. Mandatory: True. Default Value: ""
                                            • [param] -pha <string> Phase of the input: atan2(imag, real).. Mandatory: True. Default Value: ""
                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [choice] -nbinput Choice about the number of input files used to store the real and imaginary part of the SAR image one,two. Mandatory: True. Default Value: "one"
                                              • [group] -one
                                                • [param] -nbinput.one.in <string> Image file with SAR data.. Mandatory: True. Default Value: ""
                                              • [group] -two
                                                • [param] -nbinput.two.re <string> Image file with real part of the SAR data.. Mandatory: False. Default Value: ""
                                                • [param] -nbinput.two.im <string> Image file with imaginary part of the SAR data.. Mandatory: False. Default Value: ""

                                            Limitations

                                            None

                                            Authors

                                            Alexia Mondot (alexia.mondot@c-s.fr) and Mickael Savinaud (mickael.savinaud@c-s.fr)

                                            See Also

                                            Example of use

                                            • nbinput.one.in: monobandComplexFloat.tif

                                            • mod: modulus.tif

                                            • pha: phase.tif

                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputeOGRLayersFeaturesStatistics.html b/python/plugins/processing/algs/otb/description/doc/ComputeOGRLayersFeaturesStatistics.html new file mode 100644 index 00000000000..42c4651f14e --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/ComputeOGRLayersFeaturesStatistics.html @@ -0,0 +1,5 @@ + + +

                                            ComputeOGRLayersFeaturesStatistics

                                            Brief Description

                                            Compute statistics of the features in a set of OGR Layers

                                            Tags

                                            Segmentation

                                            Long Description

                                            Compute statistics (mean and standard deviation) of the features in a set of OGR Layers, and write them in an XML file. This XML file can then be used by the training application.

                                            Parameters

                                            • [param] -inshp <string> Name of the input shapefile. Mandatory: True. Default Value: ""
                                            • [param] -outstats <string> XML file containing mean and variance of each feature.. Mandatory: True. Default Value: ""
                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                              • [choice] -feat List of features to consider for statistics. . Mandatory: True. Default Value: ""

                                              Limitations

                                              Experimental. For now only shapefiles are supported.

                                              Authors

                                              David Youssefi during internship at CNES

                                              See Also

                                              OGRLayerClassifier,TrainOGRLayersClassifier

                                              Example of use

                                              • inshp: vectorData.shp

                                              • outstats: results.xml

                                              • feat: perimeter

                                              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ComputePolylineFeatureFromImage.html b/python/plugins/processing/algs/otb/description/doc/ComputePolylineFeatureFromImage.html index d22c26728c1..86cd0160012 100644 --- a/python/plugins/processing/algs/otb/description/doc/ComputePolylineFeatureFromImage.html +++ b/python/plugins/processing/algs/otb/description/doc/ComputePolylineFeatureFromImage.html @@ -2,4 +2,4 @@ -

                                              ComputePolylineFeatureFromImage

                                              Brief Description

                                              This application compute for each studied polyline, contained in the input VectorData, the chosen descriptors.

                                              Tags

                                              Feature Extraction

                                              Long Description

                                              The first step in the classifier fusion based validation is to compute, for each studied polyline, the chosen descriptors.

                                              Parameters

                                              • [param] -in <string> An image to compute the descriptors on.. Mandatory: True. Default Value: ""
                                              • [param] -vd <string> Vector data containing the polylines where the features will be computed.. Mandatory: True. Default Value: ""
                                              • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                              • [param] -expr <string> The feature formula (b1 < 0.3) where b1 is the standard name of input image first band. Mandatory: True. Default Value: ""
                                              • [param] -field <string> The field name corresponding to the feature codename (NONDVI, ROADSA...). Mandatory: True. Default Value: ""
                                              • [param] -out <string> The output vector data containing polylines with a new field. Mandatory: True. Default Value: ""

                                              Limitations

                                              Since it does not rely on streaming process, take care of the size of input image before launching application.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • in: NDVI.TIF

                                              • vd: roads_ground_truth.shp

                                              • expr: "(b1 > 0.4)"

                                              • field: NONDVI

                                              • out: PolylineFeatureFromImage_LI_NONDVI_gt.shp

                                              +

                                              ComputePolylineFeatureFromImage

                                              Brief Description

                                              This application compute for each studied polyline, contained in the input VectorData, the choosen descriptors.

                                              Tags

                                              Feature Extraction

                                              Long Description

                                              The first step in the classifier fusion based validation is to compute, for each studied polyline, the choosen descriptors.

                                              Parameters

                                              • [param] -in <string> An image to compute the descriptors on.. Mandatory: True. Default Value: ""
                                              • [param] -vd <string> Vector data containing the polylines where the features will be computed.. Mandatory: True. Default Value: ""
                                              • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                              • [param] -expr <string> The feature formula (b1 < 0.3) where b1 is the standard name of input image first band. Mandatory: True. Default Value: ""
                                              • [param] -field <string> The field name corresponding to the feature codename (NONDVI, ROADSA...). Mandatory: True. Default Value: ""
                                              • [param] -out <string> The output vector data containing polylines with a new field. Mandatory: True. Default Value: ""
                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                              Limitations

                                              Since it does not rely on streaming process, take care of the size of input image before launching application.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • in: NDVI.TIF

                                              • vd: roads_ground_truth.shp

                                              • expr: "(b1 > 0.4)"

                                              • field: NONDVI

                                              • out: PolylineFeatureFromImage_LI_NONDVI_gt.shp

                                              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ConcatenateImages.html b/python/plugins/processing/algs/otb/description/doc/ConcatenateImages.html index 76caf5d7e76..f5d2ac5e2c2 100644 --- a/python/plugins/processing/algs/otb/description/doc/ConcatenateImages.html +++ b/python/plugins/processing/algs/otb/description/doc/ConcatenateImages.html @@ -2,4 +2,4 @@ -

                                              ConcatenateImages

                                              Brief Description

                                              Concatenate a list of images of the same size into a single multi-channel one.

                                              Tags

                                              Image Manipulation,Concatenation,Multi-channel

                                              Long Description

                                              This application performs images channels concatenation. It will walk the input image list (single or multi-channel) and generates a single multi-channel image. The channel order is the one of the list.

                                              Parameters

                                              • [param] -il <string> The list of images to concatenate. Mandatory: True. Default Value: "0"
                                              • [param] -out <string> The concatenated output image. Mandatory: True. Default Value: ""
                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                              Limitations

                                              All input images must have the same size.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Rescale application, Convert

                                              Example of use

                                              • il: GomaAvant.png GomaApres.png

                                              • out: otbConcatenateImages.tif

                                              \ No newline at end of file +

                                              ConcatenateImages

                                              Brief Description

                                              Concatenate a list of images of the same size into a single multi-channel one.

                                              Tags

                                              Image Manipulation,Concatenation,Multi-channel

                                              Long Description

                                              This application performs images channels concatenation. It will walk the input image list (single or multi-channel) and generates a single multi-channel image. The channel order is the one of the list.

                                              Parameters

                                              • [param] -il <string> The list of images to concatenate. Mandatory: True. Default Value: "0"
                                              • [param] -out <string> The concatenated output image. Mandatory: True. Default Value: ""
                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                              Limitations

                                              All input images must have the same size.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Rescale application, Convert

                                              Example of use

                                              • il: GomaAvant.png GomaApres.png

                                              • out: otbConcatenateImages.tif

                                              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ConcatenateVectorData.html b/python/plugins/processing/algs/otb/description/doc/ConcatenateVectorData.html index 8ff5e5632c0..1760c34db99 100644 --- a/python/plugins/processing/algs/otb/description/doc/ConcatenateVectorData.html +++ b/python/plugins/processing/algs/otb/description/doc/ConcatenateVectorData.html @@ -2,4 +2,4 @@ -

                                              ConcatenateVectorData

                                              Brief Description

                                              Concatenate VectorDatas

                                              Tags

                                              Vector Data Manipulation

                                              Long Description

                                              This application concatenates a list of VectorData to produce a unique VectorData as output.Note that the VectorDatas must be of the same type (Storing polygons only, lines only, or points only)

                                              Parameters

                                              • [param] -vd <string> VectorData files to be concatenated in an unique VectorData. Mandatory: True. Default Value: "0"
                                              • [param] -out <string> Output conctenated VectorData. Mandatory: True. Default Value: ""

                                              Limitations

                                              None

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • vd: ToulousePoints-examples.shp ToulouseRoad-examples.shp

                                              • out: ConcatenatedVectorData.shp

                                              \ No newline at end of file +

                                              ConcatenateVectorData

                                              Brief Description

                                              Concatenate VectorDatas

                                              Tags

                                              Vector Data Manipulation

                                              Long Description

                                              This application concatenates a list of VectorData to produce a unique VectorData as output.Note that the VectorDatas must be of the same type (Storing polygons only, lines only, or points only)

                                              Parameters

                                              • [param] -vd <string> VectorData files to be concatenated in an unique VectorData. Mandatory: True. Default Value: "0"
                                              • [param] -out <string> Output conctenated VectorData. Mandatory: True. Default Value: ""
                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                              Limitations

                                              None

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • vd: ToulousePoints-examples.shp ToulouseRoad-examples.shp

                                              • out: ConcatenatedVectorData.shp

                                              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ConnectedComponentSegmentation.html b/python/plugins/processing/algs/otb/description/doc/ConnectedComponentSegmentation.html index 697cca6330e..1fa337a25af 100644 --- a/python/plugins/processing/algs/otb/description/doc/ConnectedComponentSegmentation.html +++ b/python/plugins/processing/algs/otb/description/doc/ConnectedComponentSegmentation.html @@ -2,4 +2,4 @@ -

                                              ConnectedComponentSegmentation

                                              Brief Description

                                              Connected component segmentation and object based image filtering of the input image according to user-defined criterions.

                                              Tags

                                              Image Analysis,Segmentation

                                              Long Description

                                              This application allows performing a masking, connected components segmentation and object based image filtering. First and optionally, a mask can be built based on user-defined criterions to select pixels of the image which will be segmented. Then a connected component segmentation is performed with a user defined criterion to decide whether two neighbouring pixels belong to the same segment or not. After this segmentation step, an object based image filtering is applied using another user-defined criterion reasoning on segment properties, like shape or radiometric attributes. Criterions are mathematical expressions analysed by the MuParser library (http://muparser.sourceforge.net/). For instance, expression "((b1>80) and intensity>95)" will merge two neighbouring pixel in a single segment if their intensity is more than 95 and their value in the first image band is more than 80. See parameters documentation for a list of available attributes. The output of the object based image filtering is vectorized and can be written in shapefile or KML format. If the input image is in raw geometry, resulting polygons will be transformed to WGS84 using sensor modelling before writing, to ensure consistency with GIS softwares. For this purpose, a Digital Elevation Model can be provided to the application. The whole processing is done on a per-tile basis for large images, so this application can handle images of arbitrary size.

                                              Parameters

                                              • [param] -in <string> The image to segment.. Mandatory: True. Default Value: ""
                                              • [param] -out <string> The segmentation shape.. Mandatory: True. Default Value: ""
                                              • [param] -mask <string> Mask mathematical expression (only if support image is given). Mandatory: False. Default Value: ""
                                              • [param] -expr <string> Formula used for connected component segmentation. Mandatory: True. Default Value: ""
                                              • [param] -minsize <int32> Min object size (area in pixel). Mandatory: False. Default Value: "2"
                                              • [param] -obia <string> OBIA mathematical expression. Mandatory: False. Default Value: ""
                                              • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"

                                              Limitations

                                              Due to the tiling scheme in case of large images, some segments can be arbitrarily split across multiple tiles.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • in: ROI_QB_MUL_4.tif

                                              • mask: "((b1>80)*intensity>95)"

                                              • expr: "distance<10"

                                              • minsize: 15

                                              • obia: "SHAPE_Elongation>8"

                                              • out: ConnectedComponentSegmentation.shp

                                              \ No newline at end of file +

                                              ConnectedComponentSegmentation

                                              Brief Description

                                              Connected component segmentation and object based image filtering of the input image according to user-defined criterions.

                                              Tags

                                              Image Analysis,Segmentation

                                              Long Description

                                              This application allows to perform a masking, connected components segmentation and object based image filtering. First and optionally, a mask can be built based on user-defined criterions to select pixels of the image which will be segmented. Then a connected component segmentation is performed with a user defined criterion to decide whether two neighbouring pixels belong to the same segment or not. After this segmentation step, an object based image filtering is applied using another user-defined criterion reasoning on segment properties, like shape or radiometric attributes. Criterions are mathematical expressions analysed by the MuParser library (http://muparser.sourceforge.net/). For instance, expression "((b1>80) and intensity>95)" will merge two neighbouring pixel in a single segment if their intensity is more than 95 and their value in the first image band is more than 80. See parameters documentation for a list of available attributes. The output of the object based image filtering is vectorized and can be written in shapefile or KML format. If the input image is in raw geometry, resulting polygons will be transformed to WGS84 using sensor modelling before writing, to ensure consistency with GIS softwares. For this purpose, a Digital Elevation Model can be provided to the application. The whole processing is done on a per-tile basis for large images, so this application can handle images of arbitrary size.

                                              Parameters

                                              • [param] -in <string> The image to segment.. Mandatory: True. Default Value: ""
                                              • [param] -out <string> The segmentation shape.. Mandatory: True. Default Value: ""
                                              • [param] -mask <string> Mask mathematical expression (only if support image is given). Mandatory: False. Default Value: ""
                                              • [param] -expr <string> Formula used for connected component segmentation. Mandatory: True. Default Value: ""
                                              • [param] -minsize <int32> Min object size (area in pixel). Mandatory: False. Default Value: "2"
                                              • [param] -obia <string> OBIA mathematical expression. Mandatory: False. Default Value: ""
                                              • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                              Limitations

                                              Due to the tiling scheme in case of large images, some segments can be arbitrarily split across multiple tiles.

                                              Authors

                                              OTB-Team

                                              See Also

                                              Example of use

                                              • in: ROI_QB_MUL_4.tif

                                              • mask: "((b1>80)*intensity>95)"

                                              • expr: "distance<10"

                                              • minsize: 15

                                              • obia: "SHAPE_Elongation>8"

                                              • out: ConnectedComponentSegmentation.shp

                                              \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Convert.html b/python/plugins/processing/algs/otb/description/doc/Convert.html index cab60f0c3f7..d639181f428 100644 --- a/python/plugins/processing/algs/otb/description/doc/Convert.html +++ b/python/plugins/processing/algs/otb/description/doc/Convert.html @@ -3,4 +3,4 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                              Convert

                                              Brief Description

                                              Convert an image to a different format, eventually rescaling the data and/or changing the pixel type.

                                              Tags

                                              Conversion,Image Dynamic,Image Manipulation

                                              Long Description

                                              This application performs an image pixel type conversion (short, ushort, uchar, int, uint, float and double types are handled). The output image is written in the specified format (ie. that corresponds to the given extension). - The convertion can include a rescale using the image 2 percent minimum and maximum values. The rescale can be linear or log2.

                                              Parameters

                                              • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                              • [param] -mask <string> The masked pixels won't be used to adapt the dynamic (the mask must have the same dimensions as the input image). Mandatory: False. Default Value: ""
                                              • [param] -hcp <string> Parameters to cut the histogram edges before rescaling. Mandatory: True. Default Value: "0"
                                              • [param] -out <string> Output image. Mandatory: True. Default Value: ""
                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                • [choice] -type Transfer function for the rescaling none,linear,log2. Mandatory: True. Default Value: "none"
                                                • [group] -none
                                                  • [group] -linear
                                                    • [group] -log2

                                                    Limitations

                                                    None

                                                    Authors

                                                    OTB-Team

                                                    See Also

                                                    Rescale

                                                    Example of use

                                                    • in: QB_Toulouse_Ortho_XS.tif

                                                    • out: otbConvertWithScalingOutput.png uchar

                                                    • type: linear

                                                    \ No newline at end of file + The conversion can include a rescale using the image 2 percent minimum and maximum values. The rescale can be linear or log2.

                                                    Parameters

                                                    • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                    • [param] -mask <string> The masked pixels won't be used to adapt the dynamic (the mask must have the same dimensions as the input image). Mandatory: False. Default Value: ""
                                                    • [param] -hcp <string> Parameters to cut the histogram edges before rescaling. Mandatory: True. Default Value: "0"
                                                    • [param] -out <string> Output image. Mandatory: True. Default Value: ""
                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                      • [choice] -type Transfer function for the rescaling none,linear,log2. Mandatory: True. Default Value: "none"
                                                      • [group] -none
                                                        • [group] -linear
                                                          • [param] -type.linear.gamma <float> Gamma correction factor. Mandatory: False. Default Value: "1"
                                                        • [group] -log2

                                                        Limitations

                                                        None

                                                        Authors

                                                        OTB-Team

                                                        See Also

                                                        Rescale

                                                        Example of use

                                                        • in: QB_Toulouse_Ortho_XS.tif

                                                        • out: otbConvertWithScalingOutput.png uint8

                                                        • type: linear

                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ConvertCartoToGeoPoint.html b/python/plugins/processing/algs/otb/description/doc/ConvertCartoToGeoPoint.html index 2abcdde55c2..1411d9055c5 100644 --- a/python/plugins/processing/algs/otb/description/doc/ConvertCartoToGeoPoint.html +++ b/python/plugins/processing/algs/otb/description/doc/ConvertCartoToGeoPoint.html @@ -2,4 +2,4 @@ -

                                                        ConvertCartoToGeoPoint

                                                        Brief Description

                                                        Convert cartographic coordinates to geographic one.

                                                        Tags

                                                        Coordinates,Geometry

                                                        Long Description

                                                        This application computes the geographic coordinates from a cartographic one. User has to give the X and Y coordinate and the cartographic projection (UTM/LAMBERT/LAMBERT2/LAMBERT93/SINUS/ECKERT4/TRANSMERCATOR/MOLLWEID/SVY21).

                                                        Parameters

                                                        • [param] -carto <string> . Mandatory: True. Default Value: "0"
                                                        • [param] -long <float> Point longitude coordinates.. Mandatory: True. Default Value: "0.0"
                                                        • [param] -lat <float> Point latitude coordinates.. Mandatory: True. Default Value: "0.0"
                                                          • [choice] -mapproj Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                          • [group] -utm
                                                            • [param] -mapproj.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                            • [param] -mapproj.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                          • [group] -lambert2
                                                            • [group] -lambert93
                                                              • [group] -wgs
                                                                • [group] -epsg
                                                                  • [param] -mapproj.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                              Limitations

                                                              None

                                                              Authors

                                                              OTB-Team

                                                              See Also

                                                              Example of use

                                                              • carto.x: 367074.625

                                                              • carto.y: 4835740

                                                              • mapproj: utm

                                                              • mapproj.utm.northhem: true

                                                              • mapproj.utm.zone: 31

                                                              \ No newline at end of file +

                                                              ConvertCartoToGeoPoint

                                                              Brief Description

                                                              Convert cartographic coordinates to geographic one.

                                                              Tags

                                                              Coordinates,Geometry

                                                              Long Description

                                                              This application computes the geographic coordinates from a cartographic one. User has to give the X and Y coordinate and the cartographic projection (UTM/LAMBERT/LAMBERT2/LAMBERT93/SINUS/ECKERT4/TRANSMERCATOR/MOLLWEID/SVY21).

                                                              Parameters

                                                              • [param] -carto <string> . Mandatory: True. Default Value: "0"
                                                              • [param] -long <float> Point longitude coordinates.. Mandatory: True. Default Value: "0.0"
                                                              • [param] -lat <float> Point latitude coordinates.. Mandatory: True. Default Value: "0.0"
                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                • [choice] -mapproj Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                • [group] -utm
                                                                  • [param] -mapproj.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                  • [param] -mapproj.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                • [group] -lambert2
                                                                  • [group] -lambert93
                                                                    • [group] -wgs
                                                                      • [group] -epsg
                                                                        • [param] -mapproj.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • carto.x: 367074.625

                                                                    • carto.y: 4835740

                                                                    • mapproj: utm

                                                                    • mapproj.utm.northhem: true

                                                                    • mapproj.utm.zone: 31

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ConvertSensorToGeoPoint.html b/python/plugins/processing/algs/otb/description/doc/ConvertSensorToGeoPoint.html index f80ec6b3e0b..2f7c862990d 100644 --- a/python/plugins/processing/algs/otb/description/doc/ConvertSensorToGeoPoint.html +++ b/python/plugins/processing/algs/otb/description/doc/ConvertSensorToGeoPoint.html @@ -2,4 +2,4 @@ -

                                                                    ConvertSensorToGeoPoint

                                                                    Brief Description

                                                                    Sensor to geographic coordinates conversion.

                                                                    Tags

                                                                    Geometry

                                                                    Long Description

                                                                    This Application converts a sensor point of an input image to a geographic point using the Forward Sensor Model of the input image.

                                                                    Parameters

                                                                    • [param] -in <string> Input sensor image.. Mandatory: True. Default Value: ""
                                                                    • [param] -input <string> . Mandatory: True. Default Value: "0"
                                                                    • [param] -output <string> . Mandatory: True. Default Value: "0"

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    ConvertCartoToGeoPoint application, otbObtainUTMZoneFromGeoPoint

                                                                    Example of use

                                                                    • in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                    • input.idx: 200

                                                                    • input.idy: 200

                                                                    \ No newline at end of file +

                                                                    ConvertSensorToGeoPoint

                                                                    Brief Description

                                                                    Sensor to geographic coordinates conversion.

                                                                    Tags

                                                                    Geometry

                                                                    Long Description

                                                                    This Application converts a sensor point of an input image to a geographic point using the Forward Sensor Model of the input image.

                                                                    Parameters

                                                                    • [param] -in <string> Input sensor image.. Mandatory: True. Default Value: ""
                                                                    • [param] -input <string> . Mandatory: True. Default Value: "0"
                                                                    • [param] -output <string> . Mandatory: True. Default Value: "0"
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    ConvertCartoToGeoPoint application, otbObtainUTMZoneFromGeoPoint

                                                                    Example of use

                                                                    • in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                    • input.idx: 200

                                                                    • input.idy: 200

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DEMConvert.html b/python/plugins/processing/algs/otb/description/doc/DEMConvert.html index f12d8f5cba2..e51b5030bbf 100644 --- a/python/plugins/processing/algs/otb/description/doc/DEMConvert.html +++ b/python/plugins/processing/algs/otb/description/doc/DEMConvert.html @@ -1 +1,5 @@ -

                                                                    DEM Convert Application

                                                                    Brief Description

                                                                    Convert a DEM file into a general raster

                                                                    Tags

                                                                    Image manipulation

                                                                    Long Description

                                                                    This application convert a DEM file into a general raster (.ras, .geom and .omd). To be used, those files have to be in a stand alone directory

                                                                    Parameters

                                                                    • [param] Input Image (-in): Input image to filter.

                                                                    • [param] Output prefix (-out): will be used to get the prefix of the images to write. The files - Output.geom, Output.omd and Output.ras - will be generated

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See also

                                                                    Example of use

                                                                    • Parameters to set value:

                                                                      • Input Image: QB_MUL_ROI_1000_100.tif

                                                                      • Output prefix: outputDEM.any

                                                                    • Command line to execute:

                                                                      • otbcli_DEMConvert -in QB_MUL_ROI_1000_100.tif -out outputDEM.any

                                                                    \ No newline at end of file + + +

                                                                    DEMConvert

                                                                    Brief Description

                                                                    Converts a geo-referenced DEM image into a general raster file compatible with OTB DEM handling.

                                                                    Tags

                                                                    Image Manipulation

                                                                    Long Description

                                                                    In order to be understood by the Orfeo ToolBox and the underlying OSSIM library, a geo-referenced Digital Elevation Model image can be converted into a general raster image, which consists in 3 files with the following extensions: .ras, .geom and .omd. Once converted, you have to place these files in a separate directory, and you can then use this directory to set the "DEM Directory" parameter of a DEM based OTB application or filter.

                                                                    Parameters

                                                                    • [param] -in <string> Input geo-referenced DEM to convert to general raster format.. Mandatory: True. Default Value: ""
                                                                    • [param] -out <string> 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.. Mandatory: True. Default Value: ""
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • in: QB_Toulouse_Ortho_Elev.tif

                                                                    • out: outputDEM

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DSFuzzyModelEstimation.html b/python/plugins/processing/algs/otb/description/doc/DSFuzzyModelEstimation.html index 39694ab8943..c390d5e3f63 100644 --- a/python/plugins/processing/algs/otb/description/doc/DSFuzzyModelEstimation.html +++ b/python/plugins/processing/algs/otb/description/doc/DSFuzzyModelEstimation.html @@ -2,4 +2,4 @@ -

                                                                    DSFuzzyModelEstimation

                                                                    Brief Description

                                                                    Estimate feature fuzzy model parameters using 2 vector data (ground truth samples and wrong samples).

                                                                    Tags

                                                                    Feature Extraction

                                                                    Long Description

                                                                    Estimate feature fuzzy model parameters using 2 vector data (ground truth samples and wrong samples).

                                                                    Parameters

                                                                    • [param] -psin <string> Ground truth vector data for positive samples. Mandatory: True. Default Value: ""
                                                                    • [param] -nsin <string> Ground truth vector data for negative samples. Mandatory: True. Default Value: ""
                                                                    • [param] -belsup <string> Dempster Shafer study hypothesis to compute belief. Mandatory: True. Default Value: ""
                                                                    • [param] -plasup <string> Dempster Shafer study hypothesis to compute plausibility. Mandatory: True. Default Value: ""
                                                                    • [param] -cri <string> Dempster Shafer criterion (by default (belief+plausibility)/2). Mandatory: False. Default Value: "((Belief + Plausibility)/2.)"
                                                                    • [param] -wgt <float> Coefficient between 0 and 1 to promote undetection or false detections (default 0.5). Mandatory: False. Default Value: "0.5"
                                                                    • [param] -initmod <string> Initialization model (xml file) to be used. If the xml initialization model is set, the descriptor list is not used (specified using the option -desclist). Mandatory: False. Default Value: ""
                                                                    • [param] -desclist <string> List of the descriptors to be used in the model (must be specified to perform an automatic initialization). Mandatory: False. Default Value: ""
                                                                    • [param] -maxnbit <int32> Maximum number of optimizer iteration (default 200). Mandatory: False. Default Value: "200"
                                                                    • [param] -optobs <boolean> Activate the optimizer observer. Mandatory: False. Default Value: "True"
                                                                    • [param] -out <string> Output model file name (xml file) contains the optimal model to perform information fusion.. Mandatory: True. Default Value: ""

                                                                    Limitations

                                                                    None.

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • psin: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                    • nsin: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_wr.shp

                                                                    • belsup: "ROADSA"

                                                                    • plasup: "NONDVI" "ROADSA" "NOBUIL"

                                                                    • initmod: Dempster-Shafer/DSFuzzyModel_Init.xml

                                                                    • maxnbit: 4

                                                                    • optobs: true

                                                                    • out: DSFuzzyModelEstimation.xml

                                                                    +

                                                                    DSFuzzyModelEstimation

                                                                    Brief Description

                                                                    Estimate feature fuzzy model parameters using 2 vector data (ground truth samples and wrong samples).

                                                                    Tags

                                                                    Feature Extraction

                                                                    Long Description

                                                                    Estimate feature fuzzy model parameters using 2 vector data (ground truth samples and wrong samples).

                                                                    Parameters

                                                                    • [param] -psin <string> Ground truth vector data for positive samples. Mandatory: True. Default Value: ""
                                                                    • [param] -nsin <string> Ground truth vector data for negative samples. Mandatory: True. Default Value: ""
                                                                    • [param] -belsup <string> Dempster Shafer study hypothesis to compute belief. Mandatory: True. Default Value: ""
                                                                    • [param] -plasup <string> Dempster Shafer study hypothesis to compute plausibility. Mandatory: True. Default Value: ""
                                                                    • [param] -cri <string> Dempster Shafer criterion (by default (belief+plausibility)/2). Mandatory: False. Default Value: "((Belief + Plausibility)/2.)"
                                                                    • [param] -wgt <float> Coefficient between 0 and 1 to promote undetection or false detections (default 0.5). Mandatory: False. Default Value: "0.5"
                                                                    • [param] -initmod <string> Initialization model (xml file) to be used. If the xml initialization model is set, the descriptor list is not used (specified using the option -desclist). Mandatory: False. Default Value: ""
                                                                    • [param] -desclist <string> List of the descriptors to be used in the model (must be specified to perform an automatic initialization). Mandatory: False. Default Value: ""
                                                                    • [param] -maxnbit <int32> Maximum number of optimizer iteration (default 200). Mandatory: False. Default Value: "200"
                                                                    • [param] -optobs <boolean> Activate the optimizer observer. Mandatory: False. Default Value: "True"
                                                                    • [param] -out <string> Output model file name (xml file) contains the optimal model to perform informations fusion.. Mandatory: True. Default Value: ""
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                    Limitations

                                                                    None.

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • psin: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                    • nsin: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_wr.shp

                                                                    • belsup: "ROADSA"

                                                                    • plasup: "NONDVI" "ROADSA" "NOBUIL"

                                                                    • initmod: Dempster-Shafer/DSFuzzyModel_Init.xml

                                                                    • maxnbit: 4

                                                                    • optobs: true

                                                                    • out: DSFuzzyModelEstimation.xml

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Despeckle-frost.html b/python/plugins/processing/algs/otb/description/doc/Despeckle-frost.html new file mode 100644 index 00000000000..66987867075 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/Despeckle-frost.html @@ -0,0 +1,5 @@ + + +

                                                                    Despeckle

                                                                    Brief Description

                                                                    Perform speckle noise reduction on SAR image.

                                                                    Tags

                                                                    SAR,Image Filtering

                                                                    Long Description

                                                                    This application reduce speckle noise. Two methods are available: Lee and Frost.

                                                                    Parameters

                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                    • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                      • [choice] -filter lee,frost. Mandatory: True. Default Value: "lee"
                                                                      • [group] -lee
                                                                        • [param] -filter.lee.rad <int32> Radius for lee filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.lee.nblooks <float> Nb looks for lee filter. Mandatory: True. Default Value: "1"
                                                                      • [group] -frost
                                                                        • [param] -filter.frost.rad <int32> Radius for frost filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.frost.deramp <float> Decrease factor declaration. Mandatory: True. Default Value: "0.1"

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • in: sar.tif

                                                                    • filter: lee

                                                                    • filter.lee.rad: 5

                                                                    • out: despeckle.tif

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Despeckle-lee.html b/python/plugins/processing/algs/otb/description/doc/Despeckle-lee.html new file mode 100644 index 00000000000..66987867075 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/Despeckle-lee.html @@ -0,0 +1,5 @@ + + +

                                                                    Despeckle

                                                                    Brief Description

                                                                    Perform speckle noise reduction on SAR image.

                                                                    Tags

                                                                    SAR,Image Filtering

                                                                    Long Description

                                                                    This application reduce speckle noise. Two methods are available: Lee and Frost.

                                                                    Parameters

                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                    • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                      • [choice] -filter lee,frost. Mandatory: True. Default Value: "lee"
                                                                      • [group] -lee
                                                                        • [param] -filter.lee.rad <int32> Radius for lee filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.lee.nblooks <float> Nb looks for lee filter. Mandatory: True. Default Value: "1"
                                                                      • [group] -frost
                                                                        • [param] -filter.frost.rad <int32> Radius for frost filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.frost.deramp <float> Decrease factor declaration. Mandatory: True. Default Value: "0.1"

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • in: sar.tif

                                                                    • filter: lee

                                                                    • filter.lee.rad: 5

                                                                    • out: despeckle.tif

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Despeckle.html b/python/plugins/processing/algs/otb/description/doc/Despeckle.html new file mode 100644 index 00000000000..66987867075 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/Despeckle.html @@ -0,0 +1,5 @@ + + +

                                                                    Despeckle

                                                                    Brief Description

                                                                    Perform speckle noise reduction on SAR image.

                                                                    Tags

                                                                    SAR,Image Filtering

                                                                    Long Description

                                                                    This application reduce speckle noise. Two methods are available: Lee and Frost.

                                                                    Parameters

                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                    • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                      • [choice] -filter lee,frost. Mandatory: True. Default Value: "lee"
                                                                      • [group] -lee
                                                                        • [param] -filter.lee.rad <int32> Radius for lee filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.lee.nblooks <float> Nb looks for lee filter. Mandatory: True. Default Value: "1"
                                                                      • [group] -frost
                                                                        • [param] -filter.frost.rad <int32> Radius for frost filter. Mandatory: True. Default Value: "1"
                                                                        • [param] -filter.frost.deramp <float> Decrease factor declaration. Mandatory: True. Default Value: "0.1"

                                                                    Limitations

                                                                    None

                                                                    Authors

                                                                    OTB-Team

                                                                    See Also

                                                                    Example of use

                                                                    • in: sar.tif

                                                                    • filter: lee

                                                                    • filter.lee.rad: 5

                                                                    • out: despeckle.tif

                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-ica.html b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-ica.html index 1a624e33672..487251cf0c4 100644 --- a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-ica.html +++ b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-ica.html @@ -2,4 +2,4 @@ -

                                                                    DimensionalityReduction

                                                                    Brief Description

                                                                    Perform Dimension reduction of the input image.

                                                                    Tags

                                                                    Dimensionality Reduction,Image Filtering

                                                                    Long Description

                                                                    Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available.

                                                                    Parameters

                                                                    • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                    • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                    • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                    • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                    • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                    • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                      • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                      • [group] -pca
                                                                        • [group] -napca
                                                                          • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                          • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                        • [group] -maf
                                                                          • [group] -ica
                                                                            • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                            • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                        Limitations

                                                                        Though the inverse transform can be computed, this application only provides the forward transform for now.

                                                                        Authors

                                                                        OTB-Team

                                                                        See Also

                                                                        "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                        Example of use

                                                                        • in: cupriteSubHsi.tif

                                                                        • out: FilterOutput.tif

                                                                        • method: pca

                                                                        \ No newline at end of file +

                                                                        DimensionalityReduction

                                                                        Brief Description

                                                                        Perform Dimension reduction of the input image.

                                                                        Tags

                                                                        Dimensionality Reduction,Image Filtering

                                                                        Long Description

                                                                        Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available. It is also possible to compute the inverse transform to reconstruct the image. It is also possible to optionnaly export the transformation matrix to a text file.

                                                                        Parameters

                                                                        • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                        • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                        • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                        • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                        • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                        • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                        • [param] -outmatrix <string> Filename to store the transformation matrix (csv format). Mandatory: False. Default Value: ""
                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                          • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                          • [group] -pca
                                                                            • [group] -napca
                                                                              • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                              • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                            • [group] -maf
                                                                              • [group] -ica
                                                                                • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                            Limitations

                                                                            This application does not provide the inverse transform and the transformation matrix export for the MAF.

                                                                            Authors

                                                                            OTB-Team

                                                                            See Also

                                                                            "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                            Example of use

                                                                            • in: cupriteSubHsi.tif

                                                                            • out: FilterOutput.tif

                                                                            • method: pca

                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-maf.html b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-maf.html index 1a624e33672..487251cf0c4 100644 --- a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-maf.html +++ b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-maf.html @@ -2,4 +2,4 @@ -

                                                                            DimensionalityReduction

                                                                            Brief Description

                                                                            Perform Dimension reduction of the input image.

                                                                            Tags

                                                                            Dimensionality Reduction,Image Filtering

                                                                            Long Description

                                                                            Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available.

                                                                            Parameters

                                                                            • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                            • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                            • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                            • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                            • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                            • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                              • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                              • [group] -pca
                                                                                • [group] -napca
                                                                                  • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                  • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                • [group] -maf
                                                                                  • [group] -ica
                                                                                    • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                    • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                Limitations

                                                                                Though the inverse transform can be computed, this application only provides the forward transform for now.

                                                                                Authors

                                                                                OTB-Team

                                                                                See Also

                                                                                "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                Example of use

                                                                                • in: cupriteSubHsi.tif

                                                                                • out: FilterOutput.tif

                                                                                • method: pca

                                                                                \ No newline at end of file +

                                                                                DimensionalityReduction

                                                                                Brief Description

                                                                                Perform Dimension reduction of the input image.

                                                                                Tags

                                                                                Dimensionality Reduction,Image Filtering

                                                                                Long Description

                                                                                Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available. It is also possible to compute the inverse transform to reconstruct the image. It is also possible to optionnaly export the transformation matrix to a text file.

                                                                                Parameters

                                                                                • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                • [param] -outmatrix <string> Filename to store the transformation matrix (csv format). Mandatory: False. Default Value: ""
                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                  • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                  • [group] -pca
                                                                                    • [group] -napca
                                                                                      • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                      • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                    • [group] -maf
                                                                                      • [group] -ica
                                                                                        • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                        • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                    Limitations

                                                                                    This application does not provide the inverse transform and the transformation matrix export for the MAF.

                                                                                    Authors

                                                                                    OTB-Team

                                                                                    See Also

                                                                                    "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                    Example of use

                                                                                    • in: cupriteSubHsi.tif

                                                                                    • out: FilterOutput.tif

                                                                                    • method: pca

                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-napca.html b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-napca.html index 1a624e33672..487251cf0c4 100644 --- a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-napca.html +++ b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-napca.html @@ -2,4 +2,4 @@ -

                                                                                    DimensionalityReduction

                                                                                    Brief Description

                                                                                    Perform Dimension reduction of the input image.

                                                                                    Tags

                                                                                    Dimensionality Reduction,Image Filtering

                                                                                    Long Description

                                                                                    Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available.

                                                                                    Parameters

                                                                                    • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                    • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                    • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                    • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                    • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                    • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                      • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                      • [group] -pca
                                                                                        • [group] -napca
                                                                                          • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                          • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                        • [group] -maf
                                                                                          • [group] -ica
                                                                                            • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                            • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                        Limitations

                                                                                        Though the inverse transform can be computed, this application only provides the forward transform for now.

                                                                                        Authors

                                                                                        OTB-Team

                                                                                        See Also

                                                                                        "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                        Example of use

                                                                                        • in: cupriteSubHsi.tif

                                                                                        • out: FilterOutput.tif

                                                                                        • method: pca

                                                                                        \ No newline at end of file +

                                                                                        DimensionalityReduction

                                                                                        Brief Description

                                                                                        Perform Dimension reduction of the input image.

                                                                                        Tags

                                                                                        Dimensionality Reduction,Image Filtering

                                                                                        Long Description

                                                                                        Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available. It is also possible to compute the inverse transform to reconstruct the image. It is also possible to optionnaly export the transformation matrix to a text file.

                                                                                        Parameters

                                                                                        • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                        • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                        • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                        • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                        • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                        • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                        • [param] -outmatrix <string> Filename to store the transformation matrix (csv format). Mandatory: False. Default Value: ""
                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                          • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                          • [group] -pca
                                                                                            • [group] -napca
                                                                                              • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                              • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                            • [group] -maf
                                                                                              • [group] -ica
                                                                                                • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                                • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                            Limitations

                                                                                            This application does not provide the inverse transform and the transformation matrix export for the MAF.

                                                                                            Authors

                                                                                            OTB-Team

                                                                                            See Also

                                                                                            "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                            Example of use

                                                                                            • in: cupriteSubHsi.tif

                                                                                            • out: FilterOutput.tif

                                                                                            • method: pca

                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-pca.html b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-pca.html index 1a624e33672..487251cf0c4 100644 --- a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-pca.html +++ b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction-pca.html @@ -2,4 +2,4 @@ -

                                                                                            DimensionalityReduction

                                                                                            Brief Description

                                                                                            Perform Dimension reduction of the input image.

                                                                                            Tags

                                                                                            Dimensionality Reduction,Image Filtering

                                                                                            Long Description

                                                                                            Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available.

                                                                                            Parameters

                                                                                            • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                            • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                            • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                            • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                            • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                            • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                              • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                              • [group] -pca
                                                                                                • [group] -napca
                                                                                                  • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                                  • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                                • [group] -maf
                                                                                                  • [group] -ica
                                                                                                    • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                                    • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                                Limitations

                                                                                                Though the inverse transform can be computed, this application only provides the forward transform for now.

                                                                                                Authors

                                                                                                OTB-Team

                                                                                                See Also

                                                                                                "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                                Example of use

                                                                                                • in: cupriteSubHsi.tif

                                                                                                • out: FilterOutput.tif

                                                                                                • method: pca

                                                                                                \ No newline at end of file +

                                                                                                DimensionalityReduction

                                                                                                Brief Description

                                                                                                Perform Dimension reduction of the input image.

                                                                                                Tags

                                                                                                Dimensionality Reduction,Image Filtering

                                                                                                Long Description

                                                                                                Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available. It is also possible to compute the inverse transform to reconstruct the image. It is also possible to optionnaly export the transformation matrix to a text file.

                                                                                                Parameters

                                                                                                • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                                • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                                • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                                • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                                • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                                • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                                • [param] -outmatrix <string> Filename to store the transformation matrix (csv format). Mandatory: False. Default Value: ""
                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                  • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                                  • [group] -pca
                                                                                                    • [group] -napca
                                                                                                      • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                                      • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                                    • [group] -maf
                                                                                                      • [group] -ica
                                                                                                        • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                                        • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                                    Limitations

                                                                                                    This application does not provide the inverse transform and the transformation matrix export for the MAF.

                                                                                                    Authors

                                                                                                    OTB-Team

                                                                                                    See Also

                                                                                                    "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                                    Example of use

                                                                                                    • in: cupriteSubHsi.tif

                                                                                                    • out: FilterOutput.tif

                                                                                                    • method: pca

                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction.html b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction.html index 1a624e33672..487251cf0c4 100644 --- a/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction.html +++ b/python/plugins/processing/algs/otb/description/doc/DimensionalityReduction.html @@ -2,4 +2,4 @@ -

                                                                                                    DimensionalityReduction

                                                                                                    Brief Description

                                                                                                    Perform Dimension reduction of the input image.

                                                                                                    Tags

                                                                                                    Dimensionality Reduction,Image Filtering

                                                                                                    Long Description

                                                                                                    Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available.

                                                                                                    Parameters

                                                                                                    • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                                    • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                                    • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                                    • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                                    • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                                    • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                                      • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                                      • [group] -pca
                                                                                                        • [group] -napca
                                                                                                          • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                                          • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                                        • [group] -maf
                                                                                                          • [group] -ica
                                                                                                            • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                                            • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                                        Limitations

                                                                                                        Though the inverse transform can be computed, this application only provides the forward transform for now.

                                                                                                        Authors

                                                                                                        OTB-Team

                                                                                                        See Also

                                                                                                        "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                                        Example of use

                                                                                                        • in: cupriteSubHsi.tif

                                                                                                        • out: FilterOutput.tif

                                                                                                        • method: pca

                                                                                                        \ No newline at end of file +

                                                                                                        DimensionalityReduction

                                                                                                        Brief Description

                                                                                                        Perform Dimension reduction of the input image.

                                                                                                        Tags

                                                                                                        Dimensionality Reduction,Image Filtering

                                                                                                        Long Description

                                                                                                        Performs dimensionality reduction on input image. PCA,NA-PCA,MAF,ICA methods are available. It is also possible to compute the inverse transform to reconstruct the image. It is also possible to optionnaly export the transformation matrix to a text file.

                                                                                                        Parameters

                                                                                                        • [param] -in <string> The input image to apply dimensionality reduction.. Mandatory: True. Default Value: ""
                                                                                                        • [param] -out <string> output image. Components are ordered by decreasing eigenvalues.. Mandatory: True. Default Value: ""
                                                                                                        • [param] -rescale <string> . Mandatory: False. Default Value: "0"
                                                                                                        • [param] -outinv <string> reconstruct output image.. Mandatory: False. Default Value: ""
                                                                                                        • [param] -nbcomp <int32> Number of relevant components kept. By default all components are kept.. Mandatory: False. Default Value: "0"
                                                                                                        • [param] -normalize <boolean> center AND reduce data before Dimensionality reduction.. Mandatory: False. Default Value: "True"
                                                                                                        • [param] -outmatrix <string> Filename to store the transformation matrix (csv format). Mandatory: False. Default Value: ""
                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                          • [choice] -method Selection of the reduction dimension method. pca,napca,maf,ica. Mandatory: True. Default Value: "pca"
                                                                                                          • [group] -pca
                                                                                                            • [group] -napca
                                                                                                              • [param] -method.napca.radiusx <int32> . Mandatory: True. Default Value: "1"
                                                                                                              • [param] -method.napca.radiusy <int32> . Mandatory: True. Default Value: "1"
                                                                                                            • [group] -maf
                                                                                                              • [group] -ica
                                                                                                                • [param] -method.ica.iter <int32> . Mandatory: False. Default Value: "20"
                                                                                                                • [param] -method.ica.mu <float> . Mandatory: False. Default Value: "1"

                                                                                                            Limitations

                                                                                                            This application does not provide the inverse transform and the transformation matrix export for the MAF.

                                                                                                            Authors

                                                                                                            OTB-Team

                                                                                                            See Also

                                                                                                            "Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)

                                                                                                            Example of use

                                                                                                            • in: cupriteSubHsi.tif

                                                                                                            • out: FilterOutput.tif

                                                                                                            • method: pca

                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DisparityMapToElevationMap.html b/python/plugins/processing/algs/otb/description/doc/DisparityMapToElevationMap.html index 4d72e06fd47..a24e8a020fc 100644 --- a/python/plugins/processing/algs/otb/description/doc/DisparityMapToElevationMap.html +++ b/python/plugins/processing/algs/otb/description/doc/DisparityMapToElevationMap.html @@ -2,4 +2,4 @@ -

                                                                                                            DisparityMapToElevationMap

                                                                                                            Brief Description

                                                                                                            Projects a disparity map into a regular elevation map

                                                                                                            Tags

                                                                                                            Stereo

                                                                                                            Long Description

                                                                                                            This application uses a disparity map computed from a stereo image pair to produce an elevation map on the ground area covered by the stereo pair. The needed inputs are : the disparity map, the stereo pair (in original geometry) and the epipolar deformation grids. These grids have to link the original geometry (stereo pair) and the epipolar geometry (disparity map).

                                                                                                            Parameters

                                                                                                            • [param] -io <string> This group of parameters allows setting the input and output images and grids.. Mandatory: True. Default Value: "0"
                                                                                                            • [param] -step <float> Spacing of the output elevation map (in meters). Mandatory: True. Default Value: "5"
                                                                                                            • [param] -hmin <float> Minimum elevation expected (in meters). Mandatory: True. Default Value: "0"
                                                                                                            • [param] -hmax <float> Maximum elevation expected (in meters). Mandatory: True. Default Value: "100"
                                                                                                            • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                                                                                            Limitations

                                                                                                            None

                                                                                                            Authors

                                                                                                            OTB-Team

                                                                                                            See Also

                                                                                                            otbStereoRectificationGridGenerator otbBlockMatching

                                                                                                            Example of use

                                                                                                            • io.in: disparity.tif

                                                                                                            • io.left: sensor_left.tif

                                                                                                            • io.right: sensor_right.tif

                                                                                                            • io.lgrid: grid_epi_left.tif

                                                                                                            • io.rgrid: grid_epi_right.tif

                                                                                                            • io.out: dem.tif

                                                                                                            \ No newline at end of file +

                                                                                                            DisparityMapToElevationMap

                                                                                                            Brief Description

                                                                                                            Projects a disparity map into a regular elevation map

                                                                                                            Tags

                                                                                                            Stereo

                                                                                                            Long Description

                                                                                                            This application uses a disparity map computed from a stereo image pair to produce an elevation map on the ground area covered by the stereo pair. The needed inputs are : the disparity map, the stereo pair (in original geometry) and the epipolar deformation grids. These grids have to link the original geometry (stereo pair) and the epipolar geometry (disparity map).

                                                                                                            Parameters

                                                                                                            • [param] -io <string> This group of parameters allows to set the input and output images and grids.. Mandatory: True. Default Value: "0"
                                                                                                            • [param] -step <float> Spacing of the output elevation map (in meters). Mandatory: True. Default Value: "5"
                                                                                                            • [param] -hmin <float> Minimum elevation expected (in meters). Mandatory: True. Default Value: "0"
                                                                                                            • [param] -hmax <float> Maximum elevation expected (in meters). Mandatory: True. Default Value: "100"
                                                                                                            • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                            Limitations

                                                                                                            None

                                                                                                            Authors

                                                                                                            OTB-Team

                                                                                                            See Also

                                                                                                            otbStereoRectificationGridGenerator otbBlockMatching

                                                                                                            Example of use

                                                                                                            • io.in: disparity.tif

                                                                                                            • io.left: sensor_left.tif

                                                                                                            • io.right: sensor_right.tif

                                                                                                            • io.lgrid: grid_epi_left.tif

                                                                                                            • io.rgrid: grid_epi_right.tif

                                                                                                            • io.out: dem.tif

                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/DownloadSRTMTiles.html b/python/plugins/processing/algs/otb/description/doc/DownloadSRTMTiles.html index dc686658861..2e6ee74178a 100644 --- a/python/plugins/processing/algs/otb/description/doc/DownloadSRTMTiles.html +++ b/python/plugins/processing/algs/otb/description/doc/DownloadSRTMTiles.html @@ -2,4 +2,4 @@ -

                                                                                                            DownloadSRTMTiles

                                                                                                            Brief Description

                                                                                                            Download or list SRTM tiles related to a set of images

                                                                                                            Tags

                                                                                                            Utilities,Image Manipulation

                                                                                                            Long Description

                                                                                                            This application allows selecting the appropriate SRTM tiles that covers a list of images. It builds a list of the required tiles. Two modes are available: the first one download those tiles from the USGS SRTM3 website (http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/), the second one list those tiles in a local directory. In both cases, you need to indicate the directory in which directory tiles will be download or the location of local SRTM files.

                                                                                                            Parameters

                                                                                                            • [param] -il <string> The list of images on which you want to determine corresponding SRTM tiles.. Mandatory: True. Default Value: "0"
                                                                                                              • [choice] -mode download,list. Mandatory: True. Default Value: "download"
                                                                                                              • [group] -download
                                                                                                                • [param] -mode.download.outdir <string> Directory where zipped tiles will be save. You'll need to unzip all tile files before using them in your application.. Mandatory: True. Default Value: ""
                                                                                                              • [group] -list
                                                                                                                • [param] -mode.list.indir <string> Input directory where SRTM tiles can are located.. Mandatory: True. Default Value: ""

                                                                                                            Limitations

                                                                                                            None

                                                                                                            Authors

                                                                                                            OTB-Team

                                                                                                            See Also

                                                                                                            Example of use

                                                                                                            • il: QB_Toulouse_Ortho_XS.tif

                                                                                                            • mode: list

                                                                                                            • mode.list.indir: /home/user/srtm_dir/

                                                                                                            \ No newline at end of file +

                                                                                                            DownloadSRTMTiles

                                                                                                            Brief Description

                                                                                                            Download or list SRTM tiles related to a set of images

                                                                                                            Tags

                                                                                                            Utilities,Image Manipulation

                                                                                                            Long Description

                                                                                                            This application allows to select the appropriate SRTM tiles that covers a list of images. It builds a list of the required tiles. Two modes are available: the first one download those tiles from the USGS SRTM3 website (http://dds.cr.usgs.gov/srtm/version2_1/SRTM3/), the second one list those tiles in a local directory. In both cases, you need to indicate the directory in which directory tiles will be download or the location of local SRTM files.

                                                                                                            Parameters

                                                                                                            • [param] -il <string> The list of images on which you want to determine corresponding SRTM tiles.. Mandatory: True. Default Value: "0"
                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                              • [choice] -mode download,list. Mandatory: True. Default Value: "download"
                                                                                                              • [group] -download
                                                                                                                • [param] -mode.download.outdir <string> Directory where zipped tiles will be save. You'll need to unzip all tile files before using them in your application.. Mandatory: True. Default Value: ""
                                                                                                              • [group] -list
                                                                                                                • [param] -mode.list.indir <string> Input directory where SRTM tiles can are located.. Mandatory: True. Default Value: ""

                                                                                                            Limitations

                                                                                                            None

                                                                                                            Authors

                                                                                                            OTB-Team

                                                                                                            See Also

                                                                                                            Example of use

                                                                                                            • il: QB_Toulouse_Ortho_XS.tif

                                                                                                            • mode: list

                                                                                                            • mode.list.indir: /home/user/srtm_dir/

                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-gradient.html b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-gradient.html index db327d66198..aa436906807 100644 --- a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-gradient.html +++ b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-gradient.html @@ -2,4 +2,4 @@ -

                                                                                                            EdgeExtraction

                                                                                                            Brief Description

                                                                                                            Computes edge features on every pixel of the input image selected channel

                                                                                                            Tags

                                                                                                            Edge,Feature Extraction

                                                                                                            Long Description

                                                                                                            This application computes edge features on a mono band image

                                                                                                            Parameters

                                                                                                            • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                            • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                              • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                              • [group] -gradient
                                                                                                                • [group] -sobel
                                                                                                                  • [group] -touzi
                                                                                                                    • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                    • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                Limitations

                                                                                                                None

                                                                                                                Authors

                                                                                                                OTB-Team

                                                                                                                See Also

                                                                                                                otb class

                                                                                                                Example of use

                                                                                                                • in: qb_RoadExtract.tif

                                                                                                                • channel: 1

                                                                                                                • out: Edges.tif

                                                                                                                \ No newline at end of file +

                                                                                                                EdgeExtraction

                                                                                                                Brief Description

                                                                                                                Computes edge features on every pixel of the input image selected channel

                                                                                                                Tags

                                                                                                                Edge,Feature Extraction

                                                                                                                Long Description

                                                                                                                This application computes edge features on a mono band image

                                                                                                                Parameters

                                                                                                                • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                  • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                  • [group] -gradient
                                                                                                                    • [group] -sobel
                                                                                                                      • [group] -touzi
                                                                                                                        • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                        • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                    Limitations

                                                                                                                    None

                                                                                                                    Authors

                                                                                                                    OTB-Team

                                                                                                                    See Also

                                                                                                                    otb class

                                                                                                                    Example of use

                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                    • channel: 1

                                                                                                                    • out: Edges.tif

                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-sobel.html b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-sobel.html index db327d66198..aa436906807 100644 --- a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-sobel.html +++ b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-sobel.html @@ -2,4 +2,4 @@ -

                                                                                                                    EdgeExtraction

                                                                                                                    Brief Description

                                                                                                                    Computes edge features on every pixel of the input image selected channel

                                                                                                                    Tags

                                                                                                                    Edge,Feature Extraction

                                                                                                                    Long Description

                                                                                                                    This application computes edge features on a mono band image

                                                                                                                    Parameters

                                                                                                                    • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                    • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                      • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                      • [group] -gradient
                                                                                                                        • [group] -sobel
                                                                                                                          • [group] -touzi
                                                                                                                            • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                            • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                        Limitations

                                                                                                                        None

                                                                                                                        Authors

                                                                                                                        OTB-Team

                                                                                                                        See Also

                                                                                                                        otb class

                                                                                                                        Example of use

                                                                                                                        • in: qb_RoadExtract.tif

                                                                                                                        • channel: 1

                                                                                                                        • out: Edges.tif

                                                                                                                        \ No newline at end of file +

                                                                                                                        EdgeExtraction

                                                                                                                        Brief Description

                                                                                                                        Computes edge features on every pixel of the input image selected channel

                                                                                                                        Tags

                                                                                                                        Edge,Feature Extraction

                                                                                                                        Long Description

                                                                                                                        This application computes edge features on a mono band image

                                                                                                                        Parameters

                                                                                                                        • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                        • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                        • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                          • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                          • [group] -gradient
                                                                                                                            • [group] -sobel
                                                                                                                              • [group] -touzi
                                                                                                                                • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                                • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                            Limitations

                                                                                                                            None

                                                                                                                            Authors

                                                                                                                            OTB-Team

                                                                                                                            See Also

                                                                                                                            otb class

                                                                                                                            Example of use

                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                            • channel: 1

                                                                                                                            • out: Edges.tif

                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-touzi.html b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-touzi.html index db327d66198..aa436906807 100644 --- a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-touzi.html +++ b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction-touzi.html @@ -2,4 +2,4 @@ -

                                                                                                                            EdgeExtraction

                                                                                                                            Brief Description

                                                                                                                            Computes edge features on every pixel of the input image selected channel

                                                                                                                            Tags

                                                                                                                            Edge,Feature Extraction

                                                                                                                            Long Description

                                                                                                                            This application computes edge features on a mono band image

                                                                                                                            Parameters

                                                                                                                            • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                            • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                              • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                              • [group] -gradient
                                                                                                                                • [group] -sobel
                                                                                                                                  • [group] -touzi
                                                                                                                                    • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                                    • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                                Limitations

                                                                                                                                None

                                                                                                                                Authors

                                                                                                                                OTB-Team

                                                                                                                                See Also

                                                                                                                                otb class

                                                                                                                                Example of use

                                                                                                                                • in: qb_RoadExtract.tif

                                                                                                                                • channel: 1

                                                                                                                                • out: Edges.tif

                                                                                                                                \ No newline at end of file +

                                                                                                                                EdgeExtraction

                                                                                                                                Brief Description

                                                                                                                                Computes edge features on every pixel of the input image selected channel

                                                                                                                                Tags

                                                                                                                                Edge,Feature Extraction

                                                                                                                                Long Description

                                                                                                                                This application computes edge features on a mono band image

                                                                                                                                Parameters

                                                                                                                                • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                  • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                                  • [group] -gradient
                                                                                                                                    • [group] -sobel
                                                                                                                                      • [group] -touzi
                                                                                                                                        • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                                        • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                                    Limitations

                                                                                                                                    None

                                                                                                                                    Authors

                                                                                                                                    OTB-Team

                                                                                                                                    See Also

                                                                                                                                    otb class

                                                                                                                                    Example of use

                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                    • channel: 1

                                                                                                                                    • out: Edges.tif

                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction.html b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction.html index db327d66198..aa436906807 100644 --- a/python/plugins/processing/algs/otb/description/doc/EdgeExtraction.html +++ b/python/plugins/processing/algs/otb/description/doc/EdgeExtraction.html @@ -2,4 +2,4 @@ -

                                                                                                                                    EdgeExtraction

                                                                                                                                    Brief Description

                                                                                                                                    Computes edge features on every pixel of the input image selected channel

                                                                                                                                    Tags

                                                                                                                                    Edge,Feature Extraction

                                                                                                                                    Long Description

                                                                                                                                    This application computes edge features on a mono band image

                                                                                                                                    Parameters

                                                                                                                                    • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                    • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                                      • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                                      • [group] -gradient
                                                                                                                                        • [group] -sobel
                                                                                                                                          • [group] -touzi
                                                                                                                                            • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                                            • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                                        Limitations

                                                                                                                                        None

                                                                                                                                        Authors

                                                                                                                                        OTB-Team

                                                                                                                                        See Also

                                                                                                                                        otb class

                                                                                                                                        Example of use

                                                                                                                                        • in: qb_RoadExtract.tif

                                                                                                                                        • channel: 1

                                                                                                                                        • out: Edges.tif

                                                                                                                                        \ No newline at end of file +

                                                                                                                                        EdgeExtraction

                                                                                                                                        Brief Description

                                                                                                                                        Computes edge features on every pixel of the input image selected channel

                                                                                                                                        Tags

                                                                                                                                        Edge,Feature Extraction

                                                                                                                                        Long Description

                                                                                                                                        This application computes edge features on a mono band image

                                                                                                                                        Parameters

                                                                                                                                        • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                        • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                        • [param] -out <string> Output image containing the edge features.. Mandatory: True. Default Value: ""
                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                          • [choice] -filter Choice of edge feature gradient,sobel,touzi. Mandatory: True. Default Value: "gradient"
                                                                                                                                          • [group] -gradient
                                                                                                                                            • [group] -sobel
                                                                                                                                              • [group] -touzi
                                                                                                                                                • [param] -filter.touzi.xradius <int32> . Mandatory: True. Default Value: "1"
                                                                                                                                                • [param] -filter.touzi.yradius <int32> . Mandatory: True. Default Value: "1"

                                                                                                                                            Limitations

                                                                                                                                            None

                                                                                                                                            Authors

                                                                                                                                            OTB-Team

                                                                                                                                            See Also

                                                                                                                                            otb class

                                                                                                                                            Example of use

                                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                                            • channel: 1

                                                                                                                                            • out: Edges.tif

                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentation.html b/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentation.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentation.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                            4.9.3 Segmentation

                                                                                                                                            -

                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                            Detailed description
                                                                                                                                            -

                                                                                                                                            This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                            In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                            To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                            Parameters
                                                                                                                                            -

                                                                                                                                            This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                            - - -

                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                            Parameter key

                                                                                                                                            		Parameter type

                                                                                                                                            Parameter description

                                                                                                                                            in

                                                                                                                                            		Input image

                                                                                                                                            Input Image

                                                                                                                                            filter

                                                                                                                                            		Choices

                                                                                                                                            Segmentation algorithm

                                                                                                                                            filter meanshift

                                                                                                                                            		Choice

                                                                                                                                            Mean-Shift

                                                                                                                                            filter edison

                                                                                                                                            		Choice

                                                                                                                                            Edison mean-shift

                                                                                                                                            filter cc

                                                                                                                                            		Choice

                                                                                                                                            Connected components

                                                                                                                                            filter watershed

                                                                                                                                            		Choice

                                                                                                                                            Watershed

                                                                                                                                            filter.meanshift.spatialr

                                                                                                                                            		Int

                                                                                                                                            Spatial radius

                                                                                                                                            filter.meanshift.ranger

                                                                                                                                            		Float

                                                                                                                                            Range radius

                                                                                                                                            filter.meanshift.thres

                                                                                                                                            		Float

                                                                                                                                            Mode convergence threshold

                                                                                                                                            filter.meanshift.maxiter

                                                                                                                                            		Int

                                                                                                                                            Maximum number of iterations

                                                                                                                                            filter.meanshift.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum region size

                                                                                                                                            filter.edison.spatialr

                                                                                                                                            		Int

                                                                                                                                            Spatial radius

                                                                                                                                            filter.edison.ranger

                                                                                                                                            		Float

                                                                                                                                            Range radius

                                                                                                                                            filter.edison.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum region size

                                                                                                                                            filter.edison.scale

                                                                                                                                            		Float

                                                                                                                                            Scale factor

                                                                                                                                            filter.cc.expr

                                                                                                                                            		String

                                                                                                                                            Condition

                                                                                                                                            filter.watershed.threshold

                                                                                                                                            		Float

                                                                                                                                            Depth Threshold

                                                                                                                                            filter.watershed.level

                                                                                                                                            		Float

                                                                                                                                            Flood Level

                                                                                                                                            mode

                                                                                                                                            		Choices

                                                                                                                                            Processing mode

                                                                                                                                            mode vector

                                                                                                                                            		Choice

                                                                                                                                            Tile-based large-scale segmentation with -vector output

                                                                                                                                            mode raster

                                                                                                                                            		Choice

                                                                                                                                            Standard segmentation with labeled raster -output

                                                                                                                                            mode.vector.out

                                                                                                                                            		Output File name

                                                                                                                                            Output vector file

                                                                                                                                            mode.vector.outmode

                                                                                                                                            		Choices

                                                                                                                                            Writing mode for the output vector file

                                                                                                                                            mode.vector.outmode ulco

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, only allow to -create new layers

                                                                                                                                            mode.vector.outmode ovw

                                                                                                                                            		Choice

                                                                                                                                            Overwrite output vector file if existing.

                                                                                                                                            mode.vector.outmode ulovw

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, overwrite existing -layer

                                                                                                                                            mode.vector.outmode ulu

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, update existing -layer

                                                                                                                                            mode.vector.inmask

                                                                                                                                            		Input image

                                                                                                                                            Mask Image

                                                                                                                                            mode.vector.neighbor

                                                                                                                                            		Boolean

                                                                                                                                            8-neighbor connectivity

                                                                                                                                            mode.vector.stitch

                                                                                                                                            		Boolean

                                                                                                                                            Stitch polygons

                                                                                                                                            mode.vector.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum object size

                                                                                                                                            mode.vector.simplify

                                                                                                                                            		Float

                                                                                                                                            Simplify polygons

                                                                                                                                            mode.vector.layername

                                                                                                                                            		String

                                                                                                                                            Layer name

                                                                                                                                            mode.vector.fieldname

                                                                                                                                            		String

                                                                                                                                            Geometry index field name

                                                                                                                                            mode.vector.tilesize

                                                                                                                                            		Int

                                                                                                                                            Tiles size

                                                                                                                                            mode.vector.startlabel

                                                                                                                                            		Int

                                                                                                                                            Starting geometry index

                                                                                                                                            mode.vector.ogroptions

                                                                                                                                            		String list

                                                                                                                                            OGR options for layer creation

                                                                                                                                            mode.raster.out

                                                                                                                                            		Output image

                                                                                                                                            Output labeled image

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            Table 4.50: Parameters table for Segmentation.
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Input Image -The input image to segment -

                                                                                                                                            Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                              -
                                                                                                                                            • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                -
                                                                                                                                              • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                • -
                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                • -
                                                                                                                                              • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                • -
                                                                                                                                              • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                • -
                                                                                                                                              • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                -
                                                                                                                                              • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                • -
                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                • -
                                                                                                                                              • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                • -
                                                                                                                                              • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                -
                                                                                                                                              • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                -
                                                                                                                                              • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                • -
                                                                                                                                              • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                              -
                                                                                                                                            -

                                                                                                                                            Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                              -
                                                                                                                                            • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                -
                                                                                                                                              • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                • -
                                                                                                                                              • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                • -
                                                                                                                                              • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                • -
                                                                                                                                              • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                • -
                                                                                                                                              • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                • -
                                                                                                                                              • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                • -
                                                                                                                                              • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                • -
                                                                                                                                              • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                • -
                                                                                                                                              • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                • -
                                                                                                                                              • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                • -
                                                                                                                                              • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                • -
                                                                                                                                              • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                -
                                                                                                                                              • Output labeled image: The output labeled image.
                                                                                                                                              -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            Examples
                                                                                                                                            - - -

                                                                                                                                            Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                            -

                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                            #!/usr/bin/python 
                                                                                                                                             
                                                                                                                                            # Import the otb applications package 
                                                                                                                                            import otbApplication 
                                                                                                                                             
                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                             
                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode","vector") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                             
                                                                                                                                            # The following line execute the application 
                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                            -

                                                                                                                                            Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                            -

                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                            #!/usr/bin/python 
                                                                                                                                             
                                                                                                                                            # Import the otb applications package 
                                                                                                                                            import otbApplication 
                                                                                                                                             
                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                             
                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode","raster") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                            Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                             
                                                                                                                                            # The following line execute the application 
                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            Limitations
                                                                                                                                            -

                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                            Authors
                                                                                                                                            -

                                                                                                                                            This application has been written by OTB-Team. - - -

                                                                                                                                            See also
                                                                                                                                            -

                                                                                                                                            These additional ressources can be useful for further information: -

                                                                                                                                              -
                                                                                                                                            • MeanShiftSegmentation
                                                                                                                                            - -

                                                                                                                                            - diff --git a/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentationVector.html b/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentationVector.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/EdisonMeanShiftSegmentationVector.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                            4.9.3 Segmentation

                                                                                                                                            -

                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                            Detailed description
                                                                                                                                            -

                                                                                                                                            This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                            In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                            To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                            Parameters
                                                                                                                                            -

                                                                                                                                            This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                            - - -

                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                            Parameter key

                                                                                                                                            		Parameter type

                                                                                                                                            Parameter description

                                                                                                                                            in

                                                                                                                                            		Input image

                                                                                                                                            Input Image

                                                                                                                                            filter

                                                                                                                                            		Choices

                                                                                                                                            Segmentation algorithm

                                                                                                                                            filter meanshift

                                                                                                                                            		Choice

                                                                                                                                            Mean-Shift

                                                                                                                                            filter edison

                                                                                                                                            		Choice

                                                                                                                                            Edison mean-shift

                                                                                                                                            filter cc

                                                                                                                                            		Choice

                                                                                                                                            Connected components

                                                                                                                                            filter watershed

                                                                                                                                            		Choice

                                                                                                                                            Watershed

                                                                                                                                            filter.meanshift.spatialr

                                                                                                                                            		Int

                                                                                                                                            Spatial radius

                                                                                                                                            filter.meanshift.ranger

                                                                                                                                            		Float

                                                                                                                                            Range radius

                                                                                                                                            filter.meanshift.thres

                                                                                                                                            		Float

                                                                                                                                            Mode convergence threshold

                                                                                                                                            filter.meanshift.maxiter

                                                                                                                                            		Int

                                                                                                                                            Maximum number of iterations

                                                                                                                                            filter.meanshift.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum region size

                                                                                                                                            filter.edison.spatialr

                                                                                                                                            		Int

                                                                                                                                            Spatial radius

                                                                                                                                            filter.edison.ranger

                                                                                                                                            		Float

                                                                                                                                            Range radius

                                                                                                                                            filter.edison.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum region size

                                                                                                                                            filter.edison.scale

                                                                                                                                            		Float

                                                                                                                                            Scale factor

                                                                                                                                            filter.cc.expr

                                                                                                                                            		String

                                                                                                                                            Condition

                                                                                                                                            filter.watershed.threshold

                                                                                                                                            		Float

                                                                                                                                            Depth Threshold

                                                                                                                                            filter.watershed.level

                                                                                                                                            		Float

                                                                                                                                            Flood Level

                                                                                                                                            mode

                                                                                                                                            		Choices

                                                                                                                                            Processing mode

                                                                                                                                            mode vector

                                                                                                                                            		Choice

                                                                                                                                            Tile-based large-scale segmentation with -vector output

                                                                                                                                            mode raster

                                                                                                                                            		Choice

                                                                                                                                            Standard segmentation with labeled raster -output

                                                                                                                                            mode.vector.out

                                                                                                                                            		Output File name

                                                                                                                                            Output vector file

                                                                                                                                            mode.vector.outmode

                                                                                                                                            		Choices

                                                                                                                                            Writing mode for the output vector file

                                                                                                                                            mode.vector.outmode ulco

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, only allow to -create new layers

                                                                                                                                            mode.vector.outmode ovw

                                                                                                                                            		Choice

                                                                                                                                            Overwrite output vector file if existing.

                                                                                                                                            mode.vector.outmode ulovw

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, overwrite existing -layer

                                                                                                                                            mode.vector.outmode ulu

                                                                                                                                            		Choice

                                                                                                                                            Update output vector file, update existing -layer

                                                                                                                                            mode.vector.inmask

                                                                                                                                            		Input image

                                                                                                                                            Mask Image

                                                                                                                                            mode.vector.neighbor

                                                                                                                                            		Boolean

                                                                                                                                            8-neighbor connectivity

                                                                                                                                            mode.vector.stitch

                                                                                                                                            		Boolean

                                                                                                                                            Stitch polygons

                                                                                                                                            mode.vector.minsize

                                                                                                                                            		Int

                                                                                                                                            Minimum object size

                                                                                                                                            mode.vector.simplify

                                                                                                                                            		Float

                                                                                                                                            Simplify polygons

                                                                                                                                            mode.vector.layername

                                                                                                                                            		String

                                                                                                                                            Layer name

                                                                                                                                            mode.vector.fieldname

                                                                                                                                            		String

                                                                                                                                            Geometry index field name

                                                                                                                                            mode.vector.tilesize

                                                                                                                                            		Int

                                                                                                                                            Tiles size

                                                                                                                                            mode.vector.startlabel

                                                                                                                                            		Int

                                                                                                                                            Starting geometry index

                                                                                                                                            mode.vector.ogroptions

                                                                                                                                            		String list

                                                                                                                                            OGR options for layer creation

                                                                                                                                            mode.raster.out

                                                                                                                                            		Output image

                                                                                                                                            Output labeled image

                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            Table 4.50: Parameters table for Segmentation.
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Input Image -The input image to segment -

                                                                                                                                            Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                              -
                                                                                                                                            • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                -
                                                                                                                                              • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                • -
                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                • -
                                                                                                                                              • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                • -
                                                                                                                                              • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                • -
                                                                                                                                              • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                -
                                                                                                                                              • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                • -
                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                • -
                                                                                                                                              • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                • -
                                                                                                                                              • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                -
                                                                                                                                              • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                -
                                                                                                                                              • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                • -
                                                                                                                                              • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                              -
                                                                                                                                            -

                                                                                                                                            Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                              -
                                                                                                                                            • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                -
                                                                                                                                              • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                • -
                                                                                                                                              • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                • -
                                                                                                                                              • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                • -
                                                                                                                                              • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                • -
                                                                                                                                              • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                • -
                                                                                                                                              • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                • -
                                                                                                                                              • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                • -
                                                                                                                                              • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                • -
                                                                                                                                              • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                • -
                                                                                                                                              • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                • -
                                                                                                                                              • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                • -
                                                                                                                                              • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                              -
                                                                                                                                              • -
                                                                                                                                            • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                -
                                                                                                                                              • Output labeled image: The output labeled image.
                                                                                                                                              -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            Examples
                                                                                                                                            - - -

                                                                                                                                            Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                            -

                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                            #!/usr/bin/python 
                                                                                                                                             
                                                                                                                                            # Import the otb applications package 
                                                                                                                                            import otbApplication 
                                                                                                                                             
                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                             
                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode","vector") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                             
                                                                                                                                            # The following line execute the application 
                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                            -

                                                                                                                                            Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                            -

                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                            #!/usr/bin/python 
                                                                                                                                             
                                                                                                                                            # Import the otb applications package 
                                                                                                                                            import otbApplication 
                                                                                                                                             
                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                             
                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode","raster") 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                            Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                             
                                                                                                                                            Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                             
                                                                                                                                            # The following line execute the application 
                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                            -

                                                                                                                                            -

                                                                                                                                            Limitations
                                                                                                                                            -

                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                            Authors
                                                                                                                                            -

                                                                                                                                            This application has been written by OTB-Team. - - -

                                                                                                                                            See also
                                                                                                                                            -

                                                                                                                                            These additional ressources can be useful for further information: -

                                                                                                                                              -
                                                                                                                                            • MeanShiftSegmentation
                                                                                                                                            - -

                                                                                                                                            - diff --git a/python/plugins/processing/algs/otb/description/doc/ExtractROI-fit.html b/python/plugins/processing/algs/otb/description/doc/ExtractROI-fit.html index 74b259347ec..629cad8cc9d 100644 --- a/python/plugins/processing/algs/otb/description/doc/ExtractROI-fit.html +++ b/python/plugins/processing/algs/otb/description/doc/ExtractROI-fit.html @@ -2,4 +2,4 @@ -

                                                                                                                                            ExtractROI

                                                                                                                                            Brief Description

                                                                                                                                            Extract a ROI defined by the user.

                                                                                                                                            Tags

                                                                                                                                            Image Manipulation

                                                                                                                                            Long Description

                                                                                                                                            This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                            Parameters

                                                                                                                                            • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                            • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                            • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                            • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                            • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                            • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                              • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                              • [group] -standard
                                                                                                                                                • [group] -fit
                                                                                                                                                  • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                  • [param] -mode.fit.elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                  • [param] -mode.fit.elev.dem <string> This parameter allows selecting a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                  • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                  • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                Limitations

                                                                                                                                                None

                                                                                                                                                Authors

                                                                                                                                                OTB-Team

                                                                                                                                                See Also

                                                                                                                                                Example of use

                                                                                                                                                • in: VegetationIndex.hd

                                                                                                                                                • startx: 40

                                                                                                                                                • starty: 250

                                                                                                                                                • sizex: 150

                                                                                                                                                • sizey: 150

                                                                                                                                                • out: ExtractROI.tif

                                                                                                                                                \ No newline at end of file +

                                                                                                                                                ExtractROI

                                                                                                                                                Brief Description

                                                                                                                                                Extract a ROI defined by the user.

                                                                                                                                                Tags

                                                                                                                                                Image Manipulation

                                                                                                                                                Long Description

                                                                                                                                                This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                                Parameters

                                                                                                                                                • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                                • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                                • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                  • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                                  • [group] -standard
                                                                                                                                                    • [group] -fit
                                                                                                                                                      • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                      • [param] -mode.fit.elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                      • [param] -mode.fit.elev.dem <string> This parameter allows to select a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                      • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                      • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                    [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                    Limitations

                                                                                                                                                    None

                                                                                                                                                    Authors

                                                                                                                                                    OTB-Team

                                                                                                                                                    See Also

                                                                                                                                                    Example of use

                                                                                                                                                    • in: VegetationIndex.hd

                                                                                                                                                    • startx: 40

                                                                                                                                                    • starty: 250

                                                                                                                                                    • sizex: 150

                                                                                                                                                    • sizey: 150

                                                                                                                                                    • out: ExtractROI.tif

                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ExtractROI-standard.html b/python/plugins/processing/algs/otb/description/doc/ExtractROI-standard.html index 74b259347ec..629cad8cc9d 100644 --- a/python/plugins/processing/algs/otb/description/doc/ExtractROI-standard.html +++ b/python/plugins/processing/algs/otb/description/doc/ExtractROI-standard.html @@ -2,4 +2,4 @@ -

                                                                                                                                                    ExtractROI

                                                                                                                                                    Brief Description

                                                                                                                                                    Extract a ROI defined by the user.

                                                                                                                                                    Tags

                                                                                                                                                    Image Manipulation

                                                                                                                                                    Long Description

                                                                                                                                                    This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                                    Parameters

                                                                                                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                    • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                    • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                                    • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                                    • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                    • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                      • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                                      • [group] -standard
                                                                                                                                                        • [group] -fit
                                                                                                                                                          • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                          • [param] -mode.fit.elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                          • [param] -mode.fit.elev.dem <string> This parameter allows selecting a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                          • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                          • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                        [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                        Limitations

                                                                                                                                                        None

                                                                                                                                                        Authors

                                                                                                                                                        OTB-Team

                                                                                                                                                        See Also

                                                                                                                                                        Example of use

                                                                                                                                                        • in: VegetationIndex.hd

                                                                                                                                                        • startx: 40

                                                                                                                                                        • starty: 250

                                                                                                                                                        • sizex: 150

                                                                                                                                                        • sizey: 150

                                                                                                                                                        • out: ExtractROI.tif

                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                        ExtractROI

                                                                                                                                                        Brief Description

                                                                                                                                                        Extract a ROI defined by the user.

                                                                                                                                                        Tags

                                                                                                                                                        Image Manipulation

                                                                                                                                                        Long Description

                                                                                                                                                        This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                                        Parameters

                                                                                                                                                        • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                        • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                        • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                                        • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                                        • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                        • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                          • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                                          • [group] -standard
                                                                                                                                                            • [group] -fit
                                                                                                                                                              • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                              • [param] -mode.fit.elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                              • [param] -mode.fit.elev.dem <string> This parameter allows to select a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                              • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                              • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                            [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                            Limitations

                                                                                                                                                            None

                                                                                                                                                            Authors

                                                                                                                                                            OTB-Team

                                                                                                                                                            See Also

                                                                                                                                                            Example of use

                                                                                                                                                            • in: VegetationIndex.hd

                                                                                                                                                            • startx: 40

                                                                                                                                                            • starty: 250

                                                                                                                                                            • sizex: 150

                                                                                                                                                            • sizey: 150

                                                                                                                                                            • out: ExtractROI.tif

                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ExtractROI.html b/python/plugins/processing/algs/otb/description/doc/ExtractROI.html index 74b259347ec..629cad8cc9d 100644 --- a/python/plugins/processing/algs/otb/description/doc/ExtractROI.html +++ b/python/plugins/processing/algs/otb/description/doc/ExtractROI.html @@ -2,4 +2,4 @@ -

                                                                                                                                                            ExtractROI

                                                                                                                                                            Brief Description

                                                                                                                                                            Extract a ROI defined by the user.

                                                                                                                                                            Tags

                                                                                                                                                            Image Manipulation

                                                                                                                                                            Long Description

                                                                                                                                                            This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                                            Parameters

                                                                                                                                                            • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                            • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                            • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                                            • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                                            • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                            • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                              • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                                              • [group] -standard
                                                                                                                                                                • [group] -fit
                                                                                                                                                                  • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                                  • [param] -mode.fit.elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                  • [param] -mode.fit.elev.dem <string> This parameter allows selecting a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                                  • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                                  • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                                [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                                Limitations

                                                                                                                                                                None

                                                                                                                                                                Authors

                                                                                                                                                                OTB-Team

                                                                                                                                                                See Also

                                                                                                                                                                Example of use

                                                                                                                                                                • in: VegetationIndex.hd

                                                                                                                                                                • startx: 40

                                                                                                                                                                • starty: 250

                                                                                                                                                                • sizex: 150

                                                                                                                                                                • sizey: 150

                                                                                                                                                                • out: ExtractROI.tif

                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                ExtractROI

                                                                                                                                                                Brief Description

                                                                                                                                                                Extract a ROI defined by the user.

                                                                                                                                                                Tags

                                                                                                                                                                Image Manipulation

                                                                                                                                                                Long Description

                                                                                                                                                                This application extracts a Region Of Interest with user defined size, or reference image.

                                                                                                                                                                Parameters

                                                                                                                                                                • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                                • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                • [param] -startx <int32> ROI start x position.. Mandatory: True. Default Value: "0"
                                                                                                                                                                • [param] -starty <int32> ROI start y position.. Mandatory: True. Default Value: "0"
                                                                                                                                                                • [param] -sizex <int32> size along x in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                                • [param] -sizey <int32> size along y in pixels.. Mandatory: True. Default Value: "0"
                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                  • [choice] -mode standard,fit. Mandatory: True. Default Value: "standard"
                                                                                                                                                                  • [group] -standard
                                                                                                                                                                    • [group] -fit
                                                                                                                                                                      • [param] -mode.fit.ref <string> Reference image to define the ROI. Mandatory: True. Default Value: ""
                                                                                                                                                                      • [param] -mode.fit.elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                      • [param] -mode.fit.elev.dem <string> This parameter allows to select a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""
                                                                                                                                                                      • [param] -mode.fit.elev.geoid <string> Use a geoid grid to get the height above the ellipsoid in case there is no DEM available, no coverage for some points or pixels with no_data in the DEM tiles. A version of the geoid can be found on the OTB website (http://hg.orfeo-toolbox.org/OTB-Data/raw-file/404aa6e4b3e0/Input/DEM/egm96.grd).. Mandatory: False. Default Value: ""
                                                                                                                                                                      • [param] -mode.fit.elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                                    [choice] -cl Channels to write in the output image. . Mandatory: True. Default Value: ""

                                                                                                                                                                    Limitations

                                                                                                                                                                    None

                                                                                                                                                                    Authors

                                                                                                                                                                    OTB-Team

                                                                                                                                                                    See Also

                                                                                                                                                                    Example of use

                                                                                                                                                                    • in: VegetationIndex.hd

                                                                                                                                                                    • startx: 40

                                                                                                                                                                    • starty: 250

                                                                                                                                                                    • sizex: 150

                                                                                                                                                                    • sizey: 150

                                                                                                                                                                    • out: ExtractROI.tif

                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/FineRegistration.html b/python/plugins/processing/algs/otb/description/doc/FineRegistration.html index 253696c8b3f..0c8330415a8 100644 --- a/python/plugins/processing/algs/otb/description/doc/FineRegistration.html +++ b/python/plugins/processing/algs/otb/description/doc/FineRegistration.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                    FineRegistration

                                                                                                                                                                    Brief Description

                                                                                                                                                                    Estimate disparity map between two images.

                                                                                                                                                                    Tags

                                                                                                                                                                    Stereo

                                                                                                                                                                    Long Description

                                                                                                                                                                    Estimate disparity map between two images. Output image contain x offset, y offset and metric value.

                                                                                                                                                                    Parameters

                                                                                                                                                                    • [param] -ref <string> The reference image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -sec <string> The secondary image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -out <string> The output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -erx <int32> The exploration radius along x (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -ery <int32> The exploration radius along y (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -mrx <int32> Radius along x (in pixels) of the metric computation window. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -mry <int32> Radius along y (in pixels) of the metric computation window. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -w <string> The image to warp after disparity estimation is completed. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -wo <string> The output warped image. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -cox <float> Coarse offset along x (in physical space) between the two images. Mandatory: False. Default Value: "0"
                                                                                                                                                                    • [param] -coy <float> Coarse offset along y (in physical space) between the two images. Mandatory: False. Default Value: "0"
                                                                                                                                                                    • [param] -ssrx <float> Generates a result at a coarser resolution with a given sub-sampling rate along X. Mandatory: False. Default Value: "1"
                                                                                                                                                                    • [param] -ssry <float> Generates a result at a coarser resolution with a given sub-sampling rate along Y. Mandatory: False. Default Value: "1"
                                                                                                                                                                    • [param] -rgsx <float> Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in X direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -rgsy <float> Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in Y direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -sgsx <float> Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in X direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -sgsy <float> Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in Y direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -m <string> Choose the metric used for block matching. Available metrics are cross-correlation (CC), cross-correlation with subtracted mean (CCSM), mean-square difference (MSD), mean reciprocal square difference (MRSD) and mutual information (MI). Default is cross-correlation. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -spa <float> Metric extrema location will be refined up to the given accuracy. Default is 0.01. Mandatory: False. Default Value: "0.01"
                                                                                                                                                                    • [param] -vmlt <float> Lower threshold to obtain a validity mask.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -vmut <float> Upper threshold to obtain a validity mask.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                                                                                                                                                    Limitations

                                                                                                                                                                    None

                                                                                                                                                                    Authors

                                                                                                                                                                    OTB-Team

                                                                                                                                                                    See Also

                                                                                                                                                                    Example of use

                                                                                                                                                                    • ref: StereoFixed.png

                                                                                                                                                                    • sec: StereoMoving.png

                                                                                                                                                                    • out: FineRegistration.tif

                                                                                                                                                                    • erx: 2

                                                                                                                                                                    • ery: 2

                                                                                                                                                                    • mrx: 3

                                                                                                                                                                    • mry: 3

                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                    FineRegistration

                                                                                                                                                                    Brief Description

                                                                                                                                                                    Estimate disparity map between two images.

                                                                                                                                                                    Tags

                                                                                                                                                                    Stereo

                                                                                                                                                                    Long Description

                                                                                                                                                                    Estimate disparity map between two images. Output image contain x offset, y offset and metric value.

                                                                                                                                                                    Parameters

                                                                                                                                                                    • [param] -ref <string> The reference image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -sec <string> The secondary image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -out <string> The output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                    • [param] -erx <int32> The exploration radius along x (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -ery <int32> The exploration radius along y (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -mrx <int32> Radius along x (in pixels) of the metric computation window. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -mry <int32> Radius along y (in pixels) of the metric computation window. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -w <string> The image to warp after disparity estimation is completed. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -wo <string> The output warped image. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -cox <float> Coarse offset along x (in physical space) between the two images. Mandatory: False. Default Value: "0"
                                                                                                                                                                    • [param] -coy <float> Coarse offset along y (in physical space) between the two images. Mandatory: False. Default Value: "0"
                                                                                                                                                                    • [param] -ssrx <float> Generates a result at a coarser resolution with a given sub-sampling rate along X. Mandatory: False. Default Value: "1"
                                                                                                                                                                    • [param] -ssry <float> Generates a result at a coarser resolution with a given sub-sampling rate along Y. Mandatory: False. Default Value: "1"
                                                                                                                                                                    • [param] -rgsx <float> Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in X direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -rgsy <float> Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in Y direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -sgsx <float> Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in X direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -sgsy <float> Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in Y direction.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -m <string> Choose the metric used for block matching. Available metrics are cross-correlation (CC), cross-correlation with subtracted mean (CCSM), mean-square difference (MSD), mean reciprocal square difference (MRSD) and mutual information (MI). Default is cross-correlation. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -spa <float> Metric extrema location will be refined up to the given accuracy. Default is 0.01. Mandatory: False. Default Value: "0.01"
                                                                                                                                                                    • [param] -vmlt <float> Lower threshold to obtain a validity mask.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -vmut <float> Upper threshold to obtain a validity mask.. Mandatory: False. Default Value: "0.0"
                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                    Limitations

                                                                                                                                                                    None

                                                                                                                                                                    Authors

                                                                                                                                                                    OTB-Team

                                                                                                                                                                    See Also

                                                                                                                                                                    Example of use

                                                                                                                                                                    • ref: StereoFixed.png

                                                                                                                                                                    • sec: StereoMoving.png

                                                                                                                                                                    • out: FineRegistration.tif

                                                                                                                                                                    • erx: 2

                                                                                                                                                                    • ery: 2

                                                                                                                                                                    • mrx: 3

                                                                                                                                                                    • mry: 3

                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-dempstershafer.html b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-dempstershafer.html index c59aedfce17..5805fc78cbe 100644 --- a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-dempstershafer.html +++ b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-dempstershafer.html @@ -2,8 +2,8 @@ -

                                                                                                                                                                    FusionOfClassifications

                                                                                                                                                                    Brief Description

                                                                                                                                                                    Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                    Tags

                                                                                                                                                                    Learning,Image Analysis

                                                                                                                                                                    Long Description

                                                                                                                                                                    This application allows fusing several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. +

                                                                                                                                                                    FusionOfClassifications

                                                                                                                                                                    Brief Description

                                                                                                                                                                    Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                    Tags

                                                                                                                                                                    Learning,Image Analysis

                                                                                                                                                                    Long Description

                                                                                                                                                                    This application allows to fuse several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. -MAJORITY VOTING: for each pixel, the class with the highest number of votes is selected. -DEMPSTER SHAFER: for each pixel, the class label for which the Belief Function is maximal is selected. This Belief Function is calculated by mean of the Dempster Shafer combination of Masses of Belief, and indicates the belief that each input classification map presents for each label value. Moreover, the Masses of Belief are based on the input confusion matrices of each classification map, either by using the PRECISION or RECALL rates, or the OVERALL ACCURACY, or the KAPPA coefficient. Thus, each input classification map needs to be associated with its corresponding input confusion matrix file for the Dempster Shafer fusion. -Input pixels with the NODATA label are not handled in the fusion of classification maps. Moreover, pixels for which all the input classifiers are set to NODATA keep this value in the output fused image. --In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                    Parameters

                                                                                                                                                                    • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                    • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                      • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                      • [group] -majorityvoting
                                                                                                                                                                        • [group] -dempstershafer
                                                                                                                                                                          • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                          • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                      Limitations

                                                                                                                                                                      None

                                                                                                                                                                      Authors

                                                                                                                                                                      OTB-Team

                                                                                                                                                                      See Also

                                                                                                                                                                      ImageClassifier application

                                                                                                                                                                      Example of use

                                                                                                                                                                      • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                      • method: dempstershafer

                                                                                                                                                                      • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                      • method.dempstershafer.mob: precision

                                                                                                                                                                      • nodatalabel: 0

                                                                                                                                                                      • undecidedlabel: 10

                                                                                                                                                                      • out: classification_fused.tif

                                                                                                                                                                      \ No newline at end of file +-In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                      Parameters

                                                                                                                                                                      • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                      • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                      • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                      • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                        • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                        • [group] -majorityvoting
                                                                                                                                                                          • [group] -dempstershafer
                                                                                                                                                                            • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                            • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                        Limitations

                                                                                                                                                                        None

                                                                                                                                                                        Authors

                                                                                                                                                                        OTB-Team

                                                                                                                                                                        See Also

                                                                                                                                                                        ImageClassifier application

                                                                                                                                                                        Example of use

                                                                                                                                                                        • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                        • method: dempstershafer

                                                                                                                                                                        • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                        • method.dempstershafer.mob: precision

                                                                                                                                                                        • nodatalabel: 0

                                                                                                                                                                        • undecidedlabel: 10

                                                                                                                                                                        • out: classification_fused.tif

                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-majorityvoting.html b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-majorityvoting.html index c59aedfce17..5805fc78cbe 100644 --- a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-majorityvoting.html +++ b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications-majorityvoting.html @@ -2,8 +2,8 @@ -

                                                                                                                                                                        FusionOfClassifications

                                                                                                                                                                        Brief Description

                                                                                                                                                                        Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                        Tags

                                                                                                                                                                        Learning,Image Analysis

                                                                                                                                                                        Long Description

                                                                                                                                                                        This application allows fusing several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. +

                                                                                                                                                                        FusionOfClassifications

                                                                                                                                                                        Brief Description

                                                                                                                                                                        Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                        Tags

                                                                                                                                                                        Learning,Image Analysis

                                                                                                                                                                        Long Description

                                                                                                                                                                        This application allows to fuse several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. -MAJORITY VOTING: for each pixel, the class with the highest number of votes is selected. -DEMPSTER SHAFER: for each pixel, the class label for which the Belief Function is maximal is selected. This Belief Function is calculated by mean of the Dempster Shafer combination of Masses of Belief, and indicates the belief that each input classification map presents for each label value. Moreover, the Masses of Belief are based on the input confusion matrices of each classification map, either by using the PRECISION or RECALL rates, or the OVERALL ACCURACY, or the KAPPA coefficient. Thus, each input classification map needs to be associated with its corresponding input confusion matrix file for the Dempster Shafer fusion. -Input pixels with the NODATA label are not handled in the fusion of classification maps. Moreover, pixels for which all the input classifiers are set to NODATA keep this value in the output fused image. --In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                        Parameters

                                                                                                                                                                        • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                        • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                        • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                        • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                          • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                          • [group] -majorityvoting
                                                                                                                                                                            • [group] -dempstershafer
                                                                                                                                                                              • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                              • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                          Limitations

                                                                                                                                                                          None

                                                                                                                                                                          Authors

                                                                                                                                                                          OTB-Team

                                                                                                                                                                          See Also

                                                                                                                                                                          ImageClassifier application

                                                                                                                                                                          Example of use

                                                                                                                                                                          • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                          • method: dempstershafer

                                                                                                                                                                          • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                          • method.dempstershafer.mob: precision

                                                                                                                                                                          • nodatalabel: 0

                                                                                                                                                                          • undecidedlabel: 10

                                                                                                                                                                          • out: classification_fused.tif

                                                                                                                                                                          \ No newline at end of file +-In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                          Parameters

                                                                                                                                                                          • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                          • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                          • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                          • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                            • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                            • [group] -majorityvoting
                                                                                                                                                                              • [group] -dempstershafer
                                                                                                                                                                                • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                            Limitations

                                                                                                                                                                            None

                                                                                                                                                                            Authors

                                                                                                                                                                            OTB-Team

                                                                                                                                                                            See Also

                                                                                                                                                                            ImageClassifier application

                                                                                                                                                                            Example of use

                                                                                                                                                                            • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                            • method: dempstershafer

                                                                                                                                                                            • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                            • method.dempstershafer.mob: precision

                                                                                                                                                                            • nodatalabel: 0

                                                                                                                                                                            • undecidedlabel: 10

                                                                                                                                                                            • out: classification_fused.tif

                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications.html b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications.html index c59aedfce17..5805fc78cbe 100644 --- a/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications.html +++ b/python/plugins/processing/algs/otb/description/doc/FusionOfClassifications.html @@ -2,8 +2,8 @@ -

                                                                                                                                                                            FusionOfClassifications

                                                                                                                                                                            Brief Description

                                                                                                                                                                            Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                            Tags

                                                                                                                                                                            Learning,Image Analysis

                                                                                                                                                                            Long Description

                                                                                                                                                                            This application allows fusing several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. +

                                                                                                                                                                            FusionOfClassifications

                                                                                                                                                                            Brief Description

                                                                                                                                                                            Fuses several classifications maps of the same image on the basis of class labels.

                                                                                                                                                                            Tags

                                                                                                                                                                            Learning,Image Analysis

                                                                                                                                                                            Long Description

                                                                                                                                                                            This application allows to fuse several classification maps and produces a single more robust classification map. Fusion is done either by mean of Majority Voting, or with the Dempster Shafer combination method on class labels. -MAJORITY VOTING: for each pixel, the class with the highest number of votes is selected. -DEMPSTER SHAFER: for each pixel, the class label for which the Belief Function is maximal is selected. This Belief Function is calculated by mean of the Dempster Shafer combination of Masses of Belief, and indicates the belief that each input classification map presents for each label value. Moreover, the Masses of Belief are based on the input confusion matrices of each classification map, either by using the PRECISION or RECALL rates, or the OVERALL ACCURACY, or the KAPPA coefficient. Thus, each input classification map needs to be associated with its corresponding input confusion matrix file for the Dempster Shafer fusion. -Input pixels with the NODATA label are not handled in the fusion of classification maps. Moreover, pixels for which all the input classifiers are set to NODATA keep this value in the output fused image. --In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                            Parameters

                                                                                                                                                                            • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                            • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                            • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                            • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                              • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                              • [group] -majorityvoting
                                                                                                                                                                                • [group] -dempstershafer
                                                                                                                                                                                  • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                  • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                              Limitations

                                                                                                                                                                              None

                                                                                                                                                                              Authors

                                                                                                                                                                              OTB-Team

                                                                                                                                                                              See Also

                                                                                                                                                                              ImageClassifier application

                                                                                                                                                                              Example of use

                                                                                                                                                                              • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                              • method: dempstershafer

                                                                                                                                                                              • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                              • method.dempstershafer.mob: precision

                                                                                                                                                                              • nodatalabel: 0

                                                                                                                                                                              • undecidedlabel: 10

                                                                                                                                                                              • out: classification_fused.tif

                                                                                                                                                                              \ No newline at end of file +-In case of number of votes equality, the UNDECIDED label is attributed to the pixel.

                                                                                                                                                                              Parameters

                                                                                                                                                                              • [param] -il <string> List of input classification maps to fuse. Labels in each classification image must represent the same class.. Mandatory: True. Default Value: "0"
                                                                                                                                                                              • [param] -nodatalabel <int32> Label for the NoData class. Such input pixels keep their NoData label in the output image and are not handled in the fusion process. By default, 'nodatalabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                              • [param] -undecidedlabel <int32> Label for the Undecided class. Pixels with more than 1 fused class are marked as Undecided. Please note that the Undecided value must be different from existing labels in the input classifications. By default, 'undecidedlabel = 0'.. Mandatory: True. Default Value: "0"
                                                                                                                                                                              • [param] -out <string> The output classification image resulting from the fusion of the input classification images.. Mandatory: True. Default Value: ""
                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                • [choice] -method Selection of the fusion method and its parameters. majorityvoting,dempstershafer. Mandatory: True. Default Value: "majorityvoting"
                                                                                                                                                                                • [group] -majorityvoting
                                                                                                                                                                                  • [group] -dempstershafer
                                                                                                                                                                                    • [param] -method.dempstershafer.cmfl <string> A list of confusion matrix files (*.CSV format) to define the masses of belief and the class labels. Each file should be formatted the following way: the first line, beginning with a '#' symbol, should be a list of the class labels present in the corresponding input classification image, organized in the same order as the confusion matrix rows/columns.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                    • [param] -method.dempstershafer.mob <string> Type of confusion matrix measurement used to compute the masses of belief of each classifier.. Mandatory: True. Default Value: "precision"

                                                                                                                                                                                Limitations

                                                                                                                                                                                None

                                                                                                                                                                                Authors

                                                                                                                                                                                OTB-Team

                                                                                                                                                                                See Also

                                                                                                                                                                                ImageClassifier application

                                                                                                                                                                                Example of use

                                                                                                                                                                                • il: classification1.tif classification2.tif classification3.tif

                                                                                                                                                                                • method: dempstershafer

                                                                                                                                                                                • method.dempstershafer.cmfl: classification1.csv classification2.csv classification3.csv

                                                                                                                                                                                • method.dempstershafer.mob: precision

                                                                                                                                                                                • nodatalabel: 0

                                                                                                                                                                                • undecidedlabel: 10

                                                                                                                                                                                • out: classification_fused.tif

                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GeneratePlyFile.html b/python/plugins/processing/algs/otb/description/doc/GeneratePlyFile.html index 59a15fc58e7..dfae09812b4 100644 --- a/python/plugins/processing/algs/otb/description/doc/GeneratePlyFile.html +++ b/python/plugins/processing/algs/otb/description/doc/GeneratePlyFile.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                GeneratePlyFile

                                                                                                                                                                                Brief Description

                                                                                                                                                                                Generate a 3D Ply file from a DEM and a color image.

                                                                                                                                                                                Tags

                                                                                                                                                                                Geometry

                                                                                                                                                                                Long Description

                                                                                                                                                                                Generate a 3D Ply file from a DEM and a color image.

                                                                                                                                                                                Parameters

                                                                                                                                                                                • [param] -indem <string> The input DEM. Mandatory: True. Default Value: ""
                                                                                                                                                                                • [param] -incolor <string> The input color image. Mandatory: True. Default Value: ""
                                                                                                                                                                                • [param] -out <string> The output Ply file. Mandatory: True. Default Value: ""
                                                                                                                                                                                  • [choice] -mode dem,3dgrid. Mandatory: True. Default Value: "dem"
                                                                                                                                                                                  • [group] -dem
                                                                                                                                                                                    • [group] -3dgrid
                                                                                                                                                                                      [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                      • [group] -utm
                                                                                                                                                                                        • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                        • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                      • [group] -lambert2
                                                                                                                                                                                        • [group] -lambert93
                                                                                                                                                                                          • [group] -wgs
                                                                                                                                                                                            • [group] -epsg
                                                                                                                                                                                              • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                          Limitations

                                                                                                                                                                                          Authors

                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                          See Also

                                                                                                                                                                                          Example of use

                                                                                                                                                                                          • indem: image_dem.tif

                                                                                                                                                                                          • out: out.ply

                                                                                                                                                                                          • incolor: image_color.tif

                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                          GeneratePlyFile

                                                                                                                                                                                          Brief Description

                                                                                                                                                                                          Generate a 3D Ply file from a DEM and a color image.

                                                                                                                                                                                          Tags

                                                                                                                                                                                          Geometry

                                                                                                                                                                                          Long Description

                                                                                                                                                                                          Generate a 3D Ply file from a DEM and a color image.

                                                                                                                                                                                          Parameters

                                                                                                                                                                                          • [param] -indem <string> The input DEM. Mandatory: True. Default Value: ""
                                                                                                                                                                                          • [param] -incolor <string> The input color image. Mandatory: True. Default Value: ""
                                                                                                                                                                                          • [param] -out <string> The output Ply file. Mandatory: True. Default Value: ""
                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                            • [choice] -mode dem,3dgrid. Mandatory: True. Default Value: "dem"
                                                                                                                                                                                            • [group] -dem
                                                                                                                                                                                              • [group] -3dgrid
                                                                                                                                                                                                [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                • [group] -utm
                                                                                                                                                                                                  • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                  • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                • [group] -lambert2
                                                                                                                                                                                                  • [group] -lambert93
                                                                                                                                                                                                    • [group] -wgs
                                                                                                                                                                                                      • [group] -epsg
                                                                                                                                                                                                        • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                    Authors

                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                    See Also

                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                    • indem: image_dem.tif

                                                                                                                                                                                                    • out: out.ply

                                                                                                                                                                                                    • incolor: image_color.tif

                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GenerateRPCSensorModel.html b/python/plugins/processing/algs/otb/description/doc/GenerateRPCSensorModel.html index 55a0d3ef7e1..c8a985c80f3 100644 --- a/python/plugins/processing/algs/otb/description/doc/GenerateRPCSensorModel.html +++ b/python/plugins/processing/algs/otb/description/doc/GenerateRPCSensorModel.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                    GenerateRPCSensorModel

                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                    Generate a RPC sensor model from a list of Ground Control Points.

                                                                                                                                                                                                    Tags

                                                                                                                                                                                                    Geometry

                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                    This application generates a RPC sensor model from a list of Ground Control Points. At least 20 points are required for estimation wihtout elevation support, and 40 points for estimation with elevation support. Elevation support will be automatically deactivated if an insufficient amount of points is provided. The application can optionnaly output a file containing accuracy statistics for each point, and a vector file containing segments represening points residues. The map projection parameter allows defining a map projection in which the accuracy is evaluated.

                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                    • [param] -outgeom <string> Geom file containing the generated RPC sensor model. Mandatory: True. Default Value: ""
                                                                                                                                                                                                    • [param] -inpoints <string> Input file containing tie points. Points are stored in following format: row col lon lat. Line beginning with # are ignored.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                    • [param] -outstat <string> Output file containing the following info: ref_lon ref_lat elevation predicted_lon predicted_lat x_error_ref(meters) y_error_ref(meters) global_error_ref(meters) x_error(meters) y_error(meters) overall_error(meters). Mandatory: False. Default Value: ""
                                                                                                                                                                                                    • [param] -outvector <string> File containing segments representing residues. Mandatory: False. Default Value: ""
                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                      • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                      • [group] -utm
                                                                                                                                                                                                        • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                        • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                      • [group] -lambert2
                                                                                                                                                                                                        • [group] -lambert93
                                                                                                                                                                                                          • [group] -wgs
                                                                                                                                                                                                            • [group] -epsg
                                                                                                                                                                                                              • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                          None

                                                                                                                                                                                                          Authors

                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                          See Also

                                                                                                                                                                                                          OrthoRectication,HomologousPointsExtraction,RefineSensorModel

                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                          • outgeom: output.geom

                                                                                                                                                                                                          • inpoints: points.txt

                                                                                                                                                                                                          • map: epsg

                                                                                                                                                                                                          • map.epsg.code: 32631

                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                          GenerateRPCSensorModel

                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                          Generate a RPC sensor model from a list of Ground Control Points.

                                                                                                                                                                                                          Tags

                                                                                                                                                                                                          Geometry

                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                          This application generates a RPC sensor model from a list of Ground Control Points. At least 20 points are required for estimation wihtout elevation support, and 40 points for estimation with elevation support. Elevation support will be automatically deactivated if an insufficient amount of points is provided. The application can optionnaly output a file containing accuracy statistics for each point, and a vector file containing segments represening points residues. The map projection parameter allows to define a map projection in which the accuracy is evaluated.

                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                          • [param] -outgeom <string> Geom file containing the generated RPC sensor model. Mandatory: True. Default Value: ""
                                                                                                                                                                                                          • [param] -inpoints <string> Input file containing tie points. Points are stored in following format: col row lon lat. Line beginning with # are ignored.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                          • [param] -outstat <string> Output file containing the following info: ref_lon ref_lat elevation predicted_lon predicted_lat x_error_ref(meters) y_error_ref(meters) global_error_ref(meters) x_error(meters) y_error(meters) overall_error(meters). Mandatory: False. Default Value: ""
                                                                                                                                                                                                          • [param] -outvector <string> File containing segments representing residues. Mandatory: False. Default Value: ""
                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                            • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                            • [group] -utm
                                                                                                                                                                                                              • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                              • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                            • [group] -lambert2
                                                                                                                                                                                                              • [group] -lambert93
                                                                                                                                                                                                                • [group] -wgs
                                                                                                                                                                                                                  • [group] -epsg
                                                                                                                                                                                                                    • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                None

                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                OrthoRectication,HomologousPointsExtraction,RefineSensorModel

                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                • outgeom: output.geom

                                                                                                                                                                                                                • inpoints: points.txt

                                                                                                                                                                                                                • map: epsg

                                                                                                                                                                                                                • map.epsg.code: 32631

                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-closing.html b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-closing.html index 18563e259c3..e3081bbf311 100644 --- a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-closing.html +++ b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-closing.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                GrayScaleMorphologicalOperation

                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                  • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                  • [group] -ball
                                                                                                                                                                                                                    • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                    • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                  • [group] -cross
                                                                                                                                                                                                                    [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                    • [group] -dilate
                                                                                                                                                                                                                      • [group] -erode
                                                                                                                                                                                                                        • [group] -opening
                                                                                                                                                                                                                          • [group] -closing

                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                          None

                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                          itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                          • in: qb_RoadExtract.tif

                                                                                                                                                                                                                          • out: opened.tif

                                                                                                                                                                                                                          • channel: 1

                                                                                                                                                                                                                          • structype.ball.xradius: 5

                                                                                                                                                                                                                          • structype.ball.yradius: 5

                                                                                                                                                                                                                          • filter: erode

                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                          GrayScaleMorphologicalOperation

                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                          Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                          MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                          This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                          • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                          • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                          • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                          • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                            • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                            • [group] -ball
                                                                                                                                                                                                                              • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                              • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                            • [group] -cross
                                                                                                                                                                                                                              [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                              • [group] -dilate
                                                                                                                                                                                                                                • [group] -erode
                                                                                                                                                                                                                                  • [group] -opening
                                                                                                                                                                                                                                    • [group] -closing

                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                    itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                    • out: opened.tif

                                                                                                                                                                                                                                    • channel: 1

                                                                                                                                                                                                                                    • structype.ball.xradius: 5

                                                                                                                                                                                                                                    • structype.ball.yradius: 5

                                                                                                                                                                                                                                    • filter: erode

                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-dilate.html b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-dilate.html index 18563e259c3..e3081bbf311 100644 --- a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-dilate.html +++ b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-dilate.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                    GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                    Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                    MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                    This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                    • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                    • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                      • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                      • [group] -ball
                                                                                                                                                                                                                                        • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                        • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                      • [group] -cross
                                                                                                                                                                                                                                        [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                        • [group] -dilate
                                                                                                                                                                                                                                          • [group] -erode
                                                                                                                                                                                                                                            • [group] -opening
                                                                                                                                                                                                                                              • [group] -closing

                                                                                                                                                                                                                                              Limitations

                                                                                                                                                                                                                                              None

                                                                                                                                                                                                                                              Authors

                                                                                                                                                                                                                                              OTB-Team

                                                                                                                                                                                                                                              See Also

                                                                                                                                                                                                                                              itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                              Example of use

                                                                                                                                                                                                                                              • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                              • out: opened.tif

                                                                                                                                                                                                                                              • channel: 1

                                                                                                                                                                                                                                              • structype.ball.xradius: 5

                                                                                                                                                                                                                                              • structype.ball.yradius: 5

                                                                                                                                                                                                                                              • filter: erode

                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                              GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                              Brief Description

                                                                                                                                                                                                                                              Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                              Tags

                                                                                                                                                                                                                                              MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                              Long Description

                                                                                                                                                                                                                                              This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                              • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                              • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                              • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                • [group] -ball
                                                                                                                                                                                                                                                  • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                  • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                • [group] -cross
                                                                                                                                                                                                                                                  [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                  • [group] -dilate
                                                                                                                                                                                                                                                    • [group] -erode
                                                                                                                                                                                                                                                      • [group] -opening
                                                                                                                                                                                                                                                        • [group] -closing

                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                        itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                        • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                        • out: opened.tif

                                                                                                                                                                                                                                                        • channel: 1

                                                                                                                                                                                                                                                        • structype.ball.xradius: 5

                                                                                                                                                                                                                                                        • structype.ball.yradius: 5

                                                                                                                                                                                                                                                        • filter: erode

                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-erode.html b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-erode.html index 18563e259c3..e3081bbf311 100644 --- a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-erode.html +++ b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-erode.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                        GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                        Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                        MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                        This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                        • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                        • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                        • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                          • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                          • [group] -ball
                                                                                                                                                                                                                                                            • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                            • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                          • [group] -cross
                                                                                                                                                                                                                                                            [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                            • [group] -dilate
                                                                                                                                                                                                                                                              • [group] -erode
                                                                                                                                                                                                                                                                • [group] -opening
                                                                                                                                                                                                                                                                  • [group] -closing

                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                  itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                  • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                  • out: opened.tif

                                                                                                                                                                                                                                                                  • channel: 1

                                                                                                                                                                                                                                                                  • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                  • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                  • filter: erode

                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                  GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                  Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                  MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                  This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                  • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                  • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                  • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                    • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                                    • [group] -ball
                                                                                                                                                                                                                                                                      • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                      • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                    • [group] -cross
                                                                                                                                                                                                                                                                      [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                                      • [group] -dilate
                                                                                                                                                                                                                                                                        • [group] -erode
                                                                                                                                                                                                                                                                          • [group] -opening
                                                                                                                                                                                                                                                                            • [group] -closing

                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                            itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                            • out: opened.tif

                                                                                                                                                                                                                                                                            • channel: 1

                                                                                                                                                                                                                                                                            • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                            • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                            • filter: erode

                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-opening.html b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-opening.html index 18563e259c3..e3081bbf311 100644 --- a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-opening.html +++ b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation-opening.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                            GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                            Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                            MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                            This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                            • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                              • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                                              • [group] -ball
                                                                                                                                                                                                                                                                                • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                              • [group] -cross
                                                                                                                                                                                                                                                                                [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                                                • [group] -dilate
                                                                                                                                                                                                                                                                                  • [group] -erode
                                                                                                                                                                                                                                                                                    • [group] -opening
                                                                                                                                                                                                                                                                                      • [group] -closing

                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                      itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                      • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                      • out: opened.tif

                                                                                                                                                                                                                                                                                      • channel: 1

                                                                                                                                                                                                                                                                                      • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                                      • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                                      • filter: erode

                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                      GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                      Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                      MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                      This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                      • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                      • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                      • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                        • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                                                        • [group] -ball
                                                                                                                                                                                                                                                                                          • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                          • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                        • [group] -cross
                                                                                                                                                                                                                                                                                          [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                                                          • [group] -dilate
                                                                                                                                                                                                                                                                                            • [group] -erode
                                                                                                                                                                                                                                                                                              • [group] -opening
                                                                                                                                                                                                                                                                                                • [group] -closing

                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                • out: opened.tif

                                                                                                                                                                                                                                                                                                • channel: 1

                                                                                                                                                                                                                                                                                                • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                                                • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                                                • filter: erode

                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation.html b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation.html index 18563e259c3..e3081bbf311 100644 --- a/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation.html +++ b/python/plugins/processing/algs/otb/description/doc/GrayScaleMorphologicalOperation.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                  • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                                                                  • [group] -ball
                                                                                                                                                                                                                                                                                                    • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                    • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                  • [group] -cross
                                                                                                                                                                                                                                                                                                    [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                                                                    • [group] -dilate
                                                                                                                                                                                                                                                                                                      • [group] -erode
                                                                                                                                                                                                                                                                                                        • [group] -opening
                                                                                                                                                                                                                                                                                                          • [group] -closing

                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                          itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                          • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                          • out: opened.tif

                                                                                                                                                                                                                                                                                                          • channel: 1

                                                                                                                                                                                                                                                                                                          • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                                                          • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                                                          • filter: erode

                                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                                          GrayScaleMorphologicalOperation

                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                          Performs morphological operations on a grayscale input image

                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                          MorphologicalOperations,Feature Extraction

                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                          This application performs grayscale morphological operations on a mono band image

                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                          • [param] -in <string> The input image to be filtered.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                          • [param] -out <string> Output image containing the filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                          • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                          • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                            • [choice] -structype Choice of the structuring element type ball,cross. Mandatory: True. Default Value: "ball"
                                                                                                                                                                                                                                                                                                            • [group] -ball
                                                                                                                                                                                                                                                                                                              • [param] -structype.ball.xradius <int32> The Structuring Element X Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                              • [param] -structype.ball.yradius <int32> The Structuring Element Y Radius. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                            • [group] -cross
                                                                                                                                                                                                                                                                                                              [choice] -filter Choice of the morphological operation dilate,erode,opening,closing. Mandatory: True. Default Value: "dilate"
                                                                                                                                                                                                                                                                                                              • [group] -dilate
                                                                                                                                                                                                                                                                                                                • [group] -erode
                                                                                                                                                                                                                                                                                                                  • [group] -opening
                                                                                                                                                                                                                                                                                                                    • [group] -closing

                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                    itkGrayscaleDilateImageFilter, itkGrayscaleErodeImageFilter, itkGrayscaleMorphologicalOpeningImageFilter and itkGrayscaleMorphologicalClosingImageFilter classes

                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                    • out: opened.tif

                                                                                                                                                                                                                                                                                                                    • channel: 1

                                                                                                                                                                                                                                                                                                                    • structype.ball.xradius: 5

                                                                                                                                                                                                                                                                                                                    • structype.ball.yradius: 5

                                                                                                                                                                                                                                                                                                                    • filter: erode

                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/GridBasedImageResampling.html b/python/plugins/processing/algs/otb/description/doc/GridBasedImageResampling.html index 544274bf56a..0457496e245 100644 --- a/python/plugins/processing/algs/otb/description/doc/GridBasedImageResampling.html +++ b/python/plugins/processing/algs/otb/description/doc/GridBasedImageResampling.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                    GridBasedImageResampling

                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                    Resamples an image according to a resampling grid

                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                    Geometry

                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                    This application allows performing image resampling from an input resampling grid.

                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                    • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                    • [param] -grid <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Parameters of the output image. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                      • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                      • [group] -nn
                                                                                                                                                                                                                                                                                                                        • [group] -linear
                                                                                                                                                                                                                                                                                                                          • [group] -bco
                                                                                                                                                                                                                                                                                                                            • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                        otbStereorecificationGridGeneration

                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                        • io.in: ROI_IKO_PAN_LesHalles_sub.tif

                                                                                                                                                                                                                                                                                                                        • io.out: ROI_IKO_PAN_LesHalles_sub_resampled.tif uint8

                                                                                                                                                                                                                                                                                                                        • grid.in: ROI_IKO_PAN_LesHalles_sub_deformation_field.tif

                                                                                                                                                                                                                                                                                                                        • out.sizex: 256

                                                                                                                                                                                                                                                                                                                        • out.sizey: 256

                                                                                                                                                                                                                                                                                                                        • grid.type: def

                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                        GridBasedImageResampling

                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                        Resamples an image according to a resampling grid

                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                        Geometry

                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                        This application allows to perform image resampling from an input resampling grid.

                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                        • [param] -grid <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                        • [param] -out <string> Parameters of the output image. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                          • [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                          • [group] -nn
                                                                                                                                                                                                                                                                                                                            • [group] -linear
                                                                                                                                                                                                                                                                                                                              • [group] -bco
                                                                                                                                                                                                                                                                                                                                • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                            otbStereorecificationGridGeneration

                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                            • io.in: ROI_IKO_PAN_LesHalles_sub.tif

                                                                                                                                                                                                                                                                                                                            • io.out: ROI_IKO_PAN_LesHalles_sub_resampled.tif uint8

                                                                                                                                                                                                                                                                                                                            • grid.in: ROI_IKO_PAN_LesHalles_sub_deformation_field.tif

                                                                                                                                                                                                                                                                                                                            • out.sizex: 256

                                                                                                                                                                                                                                                                                                                            • out.sizey: 256

                                                                                                                                                                                                                                                                                                                            • grid.type: def

                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/HaralickTextureExtraction.html b/python/plugins/processing/algs/otb/description/doc/HaralickTextureExtraction.html index a1d7246471e..ef966758bb6 100644 --- a/python/plugins/processing/algs/otb/description/doc/HaralickTextureExtraction.html +++ b/python/plugins/processing/algs/otb/description/doc/HaralickTextureExtraction.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                            HaralickTextureExtraction

                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                            Computes textures on every pixel of the input image selected channel

                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                            Textures,Feature Extraction

                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                            This application computes Haralick, advanced and higher order textures on a mono band image

                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.xrad <int32> X Radius. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.yrad <int32> Y Radius. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.xoff <int32> X Offset. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.yoff <int32> Y Offset. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.min <float> Image Minimum. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.max <float> Image Maximum. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                            • [param] -parameters.nbbin <int32> Histogram number of bin. Mandatory: True. Default Value: "8"
                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output image containing the selected texture features.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                              • [choice] -texture Choice of The Texture Set simple,advanced,higher. Mandatory: True. Default Value: "simple"
                                                                                                                                                                                                                                                                                                                              • [group] -simple
                                                                                                                                                                                                                                                                                                                                • [group] -advanced
                                                                                                                                                                                                                                                                                                                                  • [group] -higher

                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                  otbScalarImageToTexturesFilter, otbScalarImageToAdvancedTexturesFilter and otbScalarImageToHigherOrderTexturesFilter classes

                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                  • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                  • channel: 2

                                                                                                                                                                                                                                                                                                                                  • parameters.xrad: 3

                                                                                                                                                                                                                                                                                                                                  • parameters.yrad: 3

                                                                                                                                                                                                                                                                                                                                  • texture: simple

                                                                                                                                                                                                                                                                                                                                  • out: HaralickTextures.tif

                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                  HaralickTextureExtraction

                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                  Computes textures on every pixel of the input image selected channel

                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                  Textures,Feature Extraction

                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                  This application computes Haralick, advanced and higher order textures on a mono band image

                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                  • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                  • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.xrad <int32> X Radius. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.yrad <int32> Y Radius. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.xoff <int32> X Offset. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.yoff <int32> Y Offset. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.min <float> Image Minimum. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.max <float> Image Maximum. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                  • [param] -parameters.nbbin <int32> Histogram number of bin. Mandatory: True. Default Value: "8"
                                                                                                                                                                                                                                                                                                                                  • [param] -out <string> Output image containing the selected texture features.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                    • [choice] -texture Choice of The Texture Set simple,advanced,higher. Mandatory: True. Default Value: "simple"
                                                                                                                                                                                                                                                                                                                                    • [group] -simple
                                                                                                                                                                                                                                                                                                                                      • [group] -advanced
                                                                                                                                                                                                                                                                                                                                        • [group] -higher

                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                        otbScalarImageToTexturesFilter, otbScalarImageToAdvancedTexturesFilter and otbScalarImageToHigherOrderTexturesFilter classes

                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                        • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                        • channel: 2

                                                                                                                                                                                                                                                                                                                                        • parameters.xrad: 3

                                                                                                                                                                                                                                                                                                                                        • parameters.yrad: 3

                                                                                                                                                                                                                                                                                                                                        • texture: simple

                                                                                                                                                                                                                                                                                                                                        • out: HaralickTextures.tif

                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/HomologousPointsExtraction.html b/python/plugins/processing/algs/otb/description/doc/HomologousPointsExtraction.html index dc982b55b44..4090d2bfaf1 100644 --- a/python/plugins/processing/algs/otb/description/doc/HomologousPointsExtraction.html +++ b/python/plugins/processing/algs/otb/description/doc/HomologousPointsExtraction.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                        HomologousPointsExtraction

                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                        Allows computing of homologous points between images using keypoints

                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                        Feature Extraction

                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                        This application allows computing homologous points between images using keypoints. SIFT or SURF keypoints can be used and the band on which keypoints are computed can be set independantly for both images. The application offers two modes : the first is the full mode where keypoints are extracted from the full extent of both images (please note that in this mode large image file are not supported). The second mode, called geobins, allows setting-up spatial binning so as to get fewer points spread accross the entire image. In this mode, the corresponding spatial bin in the second image is estimated using geographical transform or sensor modelling, and is padded according to the user defined precision. Last, in both modes the application can filter matches whose colocalisation in first image exceed this precision. The elevation parameters are to deal more precisely with sensor modelling in case of sensor geometry data. The outvector option allows creating a vector file with segments corresponding to the localisation error between the matches. It can be useful to assess the precision of a registration for instance.

                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                        • [param] -in1 <string> First input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                        • [param] -band1 <int32> Index of the band from input image 1 to use for keypoints extraction. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                        • [param] -in2 <string> Second input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                        • [param] -band2 <int32> Index of the band from input image 1 to use for keypoints extraction. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                        • [param] -threshold <float> The distance threshold for matching.. Mandatory: True. Default Value: "0.6"
                                                                                                                                                                                                                                                                                                                                        • [param] -backmatching <boolean> If set to true, matches should be consistent in both ways.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                        • [param] -precision <float> Estimated precision of the colocalisation function in pixels. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                        • [param] -mfilter <boolean> If enabled, this option allows filtering matches according to colocalisation from sensor or geographical information, using the given tolerancy expressed in pixels. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                        • [param] -2wgs84 <boolean> . Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> File containing the list of tie points. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                        • [param] -outvector <string> File containing segments representing matches . Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                          • [choice] -algorithm Choice of the detection algorithm to use surf,sift. Mandatory: True. Default Value: "surf"
                                                                                                                                                                                                                                                                                                                                          • [group] -surf
                                                                                                                                                                                                                                                                                                                                            • [group] -sift
                                                                                                                                                                                                                                                                                                                                              [choice] -mode full,geobins. Mandatory: True. Default Value: "full"
                                                                                                                                                                                                                                                                                                                                              • [group] -full
                                                                                                                                                                                                                                                                                                                                                • [group] -geobins
                                                                                                                                                                                                                                                                                                                                                  • [param] -mode.geobins.binsize <int32> Radius of the spatial bin in pixels. Mandatory: True. Default Value: "256"
                                                                                                                                                                                                                                                                                                                                                  • [param] -mode.geobins.binstep <int32> Steps between bins in pixels. Mandatory: True. Default Value: "256"

                                                                                                                                                                                                                                                                                                                                              Limitations

                                                                                                                                                                                                                                                                                                                                              Full mode does not handle large images.

                                                                                                                                                                                                                                                                                                                                              Authors

                                                                                                                                                                                                                                                                                                                                              OTB-Team

                                                                                                                                                                                                                                                                                                                                              See Also

                                                                                                                                                                                                                                                                                                                                              RefineSensorModel

                                                                                                                                                                                                                                                                                                                                              Example of use

                                                                                                                                                                                                                                                                                                                                              • in1: sensor_stereo_left.tif

                                                                                                                                                                                                                                                                                                                                              • in2: sensor_stereo_right.tif

                                                                                                                                                                                                                                                                                                                                              • mode: full

                                                                                                                                                                                                                                                                                                                                              • out: homologous.txt

                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                              HomologousPointsExtraction

                                                                                                                                                                                                                                                                                                                                              Brief Description

                                                                                                                                                                                                                                                                                                                                              Allows to compute homologous points between images using keypoints

                                                                                                                                                                                                                                                                                                                                              Tags

                                                                                                                                                                                                                                                                                                                                              Feature Extraction

                                                                                                                                                                                                                                                                                                                                              Long Description

                                                                                                                                                                                                                                                                                                                                              This application allows to compute homologous points between images using keypoints. SIFT or SURF keypoints can be used and the band on which keypoints are computed can be set independantly for both images. The application offers two modes : the first is the full mode where keypoints are extracted from the full extent of both images (please note that in this mode large image file are not supported). The second mode, called geobins, allows to set-up spatial binning to get fewer points spread accross the entire image. In this mode, the corresponding spatial bin in the second image is estimated using geographical transform or sensor modelling, and is padded according to the user defined precision. Last, in both modes the application can filter matches whose colocalisation in first image exceed this precision. The elevation parameters are to deal more precisely with sensor modelling in case of sensor geometry data. The outvector option allows to create a vector file with segments corresponding to the localisation error between the matches. It can be useful to assess the precision of a registration for instance. The vector file is always reprojected to EPSG:4326 to allow display in a GIS. This is done via reprojection or by applying the image sensor models.

                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                              • [param] -in1 <string> First input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                              • [param] -band1 <int32> Index of the band from input image 1 to use for keypoints extraction. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                              • [param] -in2 <string> Second input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                              • [param] -band2 <int32> Index of the band from input image 1 to use for keypoints extraction. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                              • [param] -threshold <float> The distance threshold for matching.. Mandatory: True. Default Value: "0.6"
                                                                                                                                                                                                                                                                                                                                              • [param] -backmatching <boolean> If set to true, matches should be consistent in both ways.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                              • [param] -precision <float> Estimated precision of the colocalisation function in pixels. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                              • [param] -mfilter <boolean> If enabled, this option allows to filter matches according to colocalisation from sensor or geographical information, using the given tolerancy expressed in pixels. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                              • [param] -2wgs84 <boolean> . Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                              • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                              • [param] -out <string> File containing the list of tie points. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                              • [param] -outvector <string> File containing segments representing matches . Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                • [choice] -algorithm Choice of the detection algorithm to use surf,sift. Mandatory: True. Default Value: "surf"
                                                                                                                                                                                                                                                                                                                                                • [group] -surf
                                                                                                                                                                                                                                                                                                                                                  • [group] -sift
                                                                                                                                                                                                                                                                                                                                                    [choice] -mode full,geobins. Mandatory: True. Default Value: "full"
                                                                                                                                                                                                                                                                                                                                                    • [group] -full
                                                                                                                                                                                                                                                                                                                                                      • [group] -geobins
                                                                                                                                                                                                                                                                                                                                                        • [param] -mode.geobins.binsize <int32> Radius of the spatial bin in pixels. Mandatory: True. Default Value: "256"
                                                                                                                                                                                                                                                                                                                                                        • [param] -mode.geobins.binsizey <int32> Radius of the spatial bin in pixels (y direction). If not set, the mode.geobins.binsize value is used.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                        • [param] -mode.geobins.binstep <int32> Steps between bins in pixels. Mandatory: True. Default Value: "256"
                                                                                                                                                                                                                                                                                                                                                        • [param] -mode.geobins.binstepy <int32> Steps between bins in pixels (y direction). If not set, the mode.geobins.binstep value is used.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                        • [param] -mode.geobins.margin <int32> Margin from image border to start/end bins (in pixels). Mandatory: True. Default Value: "10"

                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                    Full mode does not handle large images.

                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                    RefineSensorModel

                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                    • in1: sensor_stereo_left.tif

                                                                                                                                                                                                                                                                                                                                                    • in2: sensor_stereo_right.tif

                                                                                                                                                                                                                                                                                                                                                    • mode: full

                                                                                                                                                                                                                                                                                                                                                    • out: homologous.txt

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/HooverCompareSegmentation.html b/python/plugins/processing/algs/otb/description/doc/HooverCompareSegmentation.html index c77e2f782b5..7fdbe9a5043 100644 --- a/python/plugins/processing/algs/otb/description/doc/HooverCompareSegmentation.html +++ b/python/plugins/processing/algs/otb/description/doc/HooverCompareSegmentation.html @@ -4,4 +4,4 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; t

                                                                                                                                                                                                                                                                                                                                                    HooverCompareSegmentation

                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                    Compare two segmentations with Hoover metrics

                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                    Segmentation

                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                    This application compares a machine segmentation (MS) with a partial ground truth segmentation (GT). The Hoover metrics are used to estimate scores for correct detection, over-segmentation, under-segmentation and missed detection. The application can output the overall Hoover scores along with coloredimages of the MS and GT segmentation showing the state of each region (correct detection, over-segmentation, under-segmentation, missed) - The Hoover metrics are described in : Hoover et al., "An experimental comparison of range image segmentation algorithms", IEEE PAMI vol. 18, no. 7, July 1996.

                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                    • [param] -ingt <string> A partial ground truth segmentation image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -inms <string> A machine segmentation image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -bg <int32> Label value of the background in the input segmentations. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -th <float> Overlapping threshold used to find Hoover instances.. Mandatory: True. Default Value: "0.75"
                                                                                                                                                                                                                                                                                                                                                    • [param] -outgt <string> The colored ground truth output image.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -outms <string> The colored machine segmentation output image.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -rc <float> Overall score for correct detection (RC). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -rf <float> Overall score for over segmentation (RF). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -ra <float> Overall score for under segmentation (RA). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -rm <float> Overall score for missed detection (RM). Mandatory: True. Default Value: "0.0"

                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                    otbHooverMatrixFilter, otbHooverInstanceFilter, otbLabelMapToAttributeImageFilter

                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                    • ingt: maur_GT.tif

                                                                                                                                                                                                                                                                                                                                                    • inms: maur_labelled.tif

                                                                                                                                                                                                                                                                                                                                                    • outgt: maur_colored_GT.tif uint8

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file + The Hoover metrics are described in : Hoover et al., "An experimental comparison of range image segmentation algorithms", IEEE PAMI vol. 18, no. 7, July 1996.

                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                    • [param] -ingt <string> A partial ground truth segmentation image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -inms <string> A machine segmentation image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -bg <int32> Label value of the background in the input segmentations. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -th <float> Overlapping threshold used to find Hoover instances.. Mandatory: True. Default Value: "0.75"
                                                                                                                                                                                                                                                                                                                                                    • [param] -outgt <string> The colored ground truth output image.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -outms <string> The colored machine segmentation output image.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -rc <float> Overall score for correct detection (RC). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -rf <float> Overall score for over segmentation (RF). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -ra <float> Overall score for under segmentation (RA). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -rm <float> Overall score for missed detection (RM). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                    otbHooverMatrixFilter, otbHooverInstanceFilter, otbLabelMapToAttributeImageFilter

                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                    • ingt: maur_GT.tif

                                                                                                                                                                                                                                                                                                                                                    • inms: maur_labelled.tif

                                                                                                                                                                                                                                                                                                                                                    • outgt: maur_colored_GT.tif uint8

                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/HyperspectralUnmixing.html b/python/plugins/processing/algs/otb/description/doc/HyperspectralUnmixing.html index f903236aae5..1ca186d16a6 100644 --- a/python/plugins/processing/algs/otb/description/doc/HyperspectralUnmixing.html +++ b/python/plugins/processing/algs/otb/description/doc/HyperspectralUnmixing.html @@ -4,5 +4,5 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; t

                                                                                                                                                                                                                                                                                                                                                    HyperspectralUnmixing

                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                    Estimate abundance maps from an hyperspectral image and a set of endmembers.

                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                    Hyperspectral

                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                    The application applies a linear unmixing algorithm to an hyperspectral data cube. This method supposes that the mixture between materials in the scene is macroscopic and simulates a linear mixing model of spectra. The Linear Mixing Model (LMM) acknowledges that reflectance spectrum associated with each pixel is a linear combination of pure materials in the recovery area, commonly known as endmembers. Endmembers can be estimated using the VertexComponentAnalysis application. -The application allows estimating the abundance maps with several algorithms : Unconstrained Least Square (ucls), Fully Constrained Least Square (fcls), Image Space Reconstruction Algorithm (isra) and Non-negative constrained Least Square (ncls) and Minimum Dispersion Constrained Non Negative Matrix Factorization (MDMDNMF). -

                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The hyperspectral data cube to unmix. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> The output abundance map. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                    • [param] -ie <string> The endmembers (estimated pure pixels) to use for unmixing. Must be stored as a multispectral image, where each pixel is interpreted as an endmember. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                      • [choice] -ua The algorithm to use for unmixing ucls,ncls,isra,mdmdnmf. Mandatory: False. Default Value: "ucls"
                                                                                                                                                                                                                                                                                                                                                      • [group] -ucls
                                                                                                                                                                                                                                                                                                                                                        • [group] -ncls
                                                                                                                                                                                                                                                                                                                                                          • [group] -isra
                                                                                                                                                                                                                                                                                                                                                            • [group] -mdmdnmf

                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                            VertexComponentAnalysis

                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                            • in: cupriteSubHsi.tif

                                                                                                                                                                                                                                                                                                                                                            • ie: cupriteEndmembers.tif

                                                                                                                                                                                                                                                                                                                                                            • out: HyperspectralUnmixing.tif double

                                                                                                                                                                                                                                                                                                                                                            • ua: ucls

                                                                                                                                                                                                                                                                                                                                                            +The application allows to estimate the abundance maps with several algorithms : Unconstrained Least Square (ucls), Fully Constrained Least Square (fcls), Image Space Reconstruction Algorithm (isra) and Non-negative constrained Least Square (ncls) and Minimum Dispertion Constrained Non Negative Matrix Factorization (MDMDNMF). +

                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The hyperspectral data cube to unmix. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> The output abundance map. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                            • [param] -ie <string> The endmembers (estimated pure pixels) to use for unmixing. Must be stored as a multispectral image, where each pixel is interpreted as an endmember. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                              • [choice] -ua The algorithm to use for unmixing ucls,ncls,isra,mdmdnmf. Mandatory: False. Default Value: "ucls"
                                                                                                                                                                                                                                                                                                                                                              • [group] -ucls
                                                                                                                                                                                                                                                                                                                                                                • [group] -ncls
                                                                                                                                                                                                                                                                                                                                                                  • [group] -isra
                                                                                                                                                                                                                                                                                                                                                                    • [group] -mdmdnmf

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    VertexComponentAnalysis

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: cupriteSubHsi.tif

                                                                                                                                                                                                                                                                                                                                                                    • ie: cupriteEndmembers.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: HyperspectralUnmixing.tif double

                                                                                                                                                                                                                                                                                                                                                                    • ua: ucls

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ImageClassifier.html b/python/plugins/processing/algs/otb/description/doc/ImageClassifier.html index 457cd2d24ac..d9267f43044 100644 --- a/python/plugins/processing/algs/otb/description/doc/ImageClassifier.html +++ b/python/plugins/processing/algs/otb/description/doc/ImageClassifier.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    ImageClassifier

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Performs a classification of the input image according to a model file.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Learning

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs an image classification based on a model file produced by the TrainImagesClassifier application. Pixels of the output image will contain the class labels decided by the classifier (maximal class label = 65535). The input pixels can be optionally centered and reduced according to the statistics file produced by the ComputeImagesStatistics application. An optional input mask can be provided, in which case only input image pixels whose corresponding mask value is greater than 0 will be classified. The remaining of pixels will be given the label 0 in the output image.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -mask <string> The mask allows restricting classification of the input image to the area where mask pixel values are greater than 0.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -model <string> A model file (produced by TrainImagesClassifier application, maximal class label = 65535).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -imstat <string> A XML file containing mean and standard deviation to center and reduce samples before classification (produced by ComputeImagesStatistics application).. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing class labels. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    The input image must have the same type, order and number of bands than the images used to produce the statistics file and the SVM model file. If a statistics file was used during training by the TrainImagesClassifier, it is mandatory to use the same statistics file for classification. If an input mask is used, its size must match the input image size.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    TrainImagesClassifier, ValidateImagesClassifier, ComputeImagesStatistics

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                    • imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                    • model: clsvmModelQB1.svm

                                                                                                                                                                                                                                                                                                                                                                    • out: clLabeledImageQB1.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    ImageClassifier

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Performs a classification of the input image according to a model file.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Learning

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs an image classification based on a model file produced by the TrainImagesClassifier application. Pixels of the output image will contain the class labels decided by the classifier (maximal class label = 65535). The input pixels can be optionally centered and reduced according to the statistics file produced by the ComputeImagesStatistics application. An optional input mask can be provided, in which case only input image pixels whose corresponding mask value is greater than 0 will be classified. The remaining of pixels will be given the label 0 in the output image.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -mask <string> The mask allows to restrict classification of the input image to the area where mask pixel values are greater than 0.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -model <string> A model file (produced by TrainImagesClassifier application, maximal class label = 65535).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -imstat <string> A XML file containing mean and standard deviation to center and reduce samples before classification (produced by ComputeImagesStatistics application).. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing class labels. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    The input image must have the same type, order and number of bands than the images used to produce the statistics file and the SVM model file. If a statistics file was used during training by the TrainImagesClassifier, it is mandatory to use the same statistics file for classification. If an input mask is used, its size must match the input image size.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    TrainImagesClassifier, ValidateImagesClassifier, ComputeImagesStatistics

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                    • imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                    • model: clsvmModelQB1.svm

                                                                                                                                                                                                                                                                                                                                                                    • out: clLabeledImageQB1.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ImageEnvelope.html b/python/plugins/processing/algs/otb/description/doc/ImageEnvelope.html index b2ea9da5fd7..80ab8b1327d 100644 --- a/python/plugins/processing/algs/otb/description/doc/ImageEnvelope.html +++ b/python/plugins/processing/algs/otb/description/doc/ImageEnvelope.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    ImageEnvelope

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Extracts an image envelope.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Geometry

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    Build a vector data containing the polygon of the image envelope.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Vector data file containing the envelope. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -sr <int32> Sampling rate for image edges (in pixel). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -proj <string> Projection to be used to compute the envelope (default is WGS84). Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: ImageEnvelope.shp

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    ImageEnvelope

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Extracts an image envelope.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Geometry

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    Build a vector data containing the polygon of the image envelope.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Vector data file containing the envelope. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -sr <int32> Sampling rate for image edges (in pixel). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -proj <string> Projection to be used to compute the envelope (default is WGS84). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: ImageEnvelope.shp

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ImageSVMClassifier.html b/python/plugins/processing/algs/otb/description/doc/ImageSVMClassifier.html deleted file mode 100644 index 71b09eea17b..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/ImageSVMClassifier.html +++ /dev/null @@ -1 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                    Image SVM Classification

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Performs a SVM classification of the input image according to a SVM model file.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Learning

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs a SVM image classification based on a SVM model file (*.svm extension) produced by the TrainSVMImagesClassifier application. Pixels of the output image will contain the class label decided by the SVM classifier. The input pixels can be optionnaly centered and reduced according to the statistics file produced by the ComputeImagesStatistics application. An optional input mask can be provided, in which case only input image pixels whose corresponding mask value is greater than 0 will be classified. The remaining of pixels will be given the label 0 in the output image.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] Input Image (-in): The input Image to classify.

                                                                                                                                                                                                                                                                                                                                                                    • [param] Input Mask (-mask): The mask allows restricting classification of the input image to the area where mask pixel values are greater than 0.

                                                                                                                                                                                                                                                                                                                                                                    • [param] SVM Model file (-svm): A SVM model file.

                                                                                                                                                                                                                                                                                                                                                                    • [param] Statistics file (-imstat): A XML file containing mean and standard deviation to center and reduce samples before classification.

                                                                                                                                                                                                                                                                                                                                                                    • [param] Output Image (-out): Output image labeled with class labels

                                                                                                                                                                                                                                                                                                                                                                    • [param] Available RAM (-ram): Available RAM

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    The input image must have the same type, order and number of bands than the images used to produce the statistics file and the SVM model file. If a statistics file was used during training by the TrainSVMImagesClassifier, it is mandatory to use the same statistics file for classification. If an input mask is used, its size must match the input image size.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See also

                                                                                                                                                                                                                                                                                                                                                                    TrainSVMImagesClassifier, ValidateSVMImagesClassifier, ComputeImagesStatistics

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                      • Input Image: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                      • SVM Model file: clsvmModelQB1.svm

                                                                                                                                                                                                                                                                                                                                                                      • Statistics file: clImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                      • Output Image: otbConcatenateImages.png uchar

                                                                                                                                                                                                                                                                                                                                                                    • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                      • otbcli_ImageSVMClassifier -in QB_1_ortho.tif -svm clsvmModelQB1.svm -imstat clImageStatisticsQB1.xml -out otbConcatenateImages.png uchar

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/KMeansClassification.html b/python/plugins/processing/algs/otb/description/doc/KMeansClassification.html index 182c1a17836..47414f7b94d 100644 --- a/python/plugins/processing/algs/otb/description/doc/KMeansClassification.html +++ b/python/plugins/processing/algs/otb/description/doc/KMeansClassification.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    KMeansClassification

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Unsupervised KMeans image classification

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Segmentation,Learning

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    Performs unsupervised KMeans image classification.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing the class indexes.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -vm <string> Validity mask. Only non-zero pixels will be used to estimate KMeans modes.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ts <int32> Size of the training set (in pixels).. Mandatory: False. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -nc <int32> Number of modes, which will be used to generate class membership.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -maxit <int32> Maximum number of iterations for the learning step.. Mandatory: False. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ct <float> Convergence threshold for class centroid (L2 distance, by default 0.0001).. Mandatory: False. Default Value: "0.0001"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outmeans <string> Output text file containing centroid positions. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                    • ts: 1000

                                                                                                                                                                                                                                                                                                                                                                    • nc: 5

                                                                                                                                                                                                                                                                                                                                                                    • maxit: 1000

                                                                                                                                                                                                                                                                                                                                                                    • ct: 0.0001

                                                                                                                                                                                                                                                                                                                                                                    • out: ClassificationFilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    KMeansClassification

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Unsupervised KMeans image classification

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Segmentation,Learning

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    Performs unsupervised KMeans image classification.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing the class indexes.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -vm <string> Validity mask. Only non-zero pixels will be used to estimate KMeans modes.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ts <int32> Size of the training set (in pixels).. Mandatory: False. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -nc <int32> Number of modes, which will be used to generate class membership.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -maxit <int32> Maximum number of iterations for the learning step.. Mandatory: False. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ct <float> Convergence threshold for class centroid (L2 distance, by default 0.0001).. Mandatory: False. Default Value: "0.0001"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outmeans <string> Output text file containing centroid positions. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                    • ts: 1000

                                                                                                                                                                                                                                                                                                                                                                    • nc: 5

                                                                                                                                                                                                                                                                                                                                                                    • maxit: 1000

                                                                                                                                                                                                                                                                                                                                                                    • ct: 0.0001

                                                                                                                                                                                                                                                                                                                                                                    • out: ClassificationFilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/KmzExport.html b/python/plugins/processing/algs/otb/description/doc/KmzExport.html index 36b115c39fa..23ed618c94e 100644 --- a/python/plugins/processing/algs/otb/description/doc/KmzExport.html +++ b/python/plugins/processing/algs/otb/description/doc/KmzExport.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    KmzExport

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Export the input image in a KMZ product.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    KMZ,Export

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application exports the input image in a kmz product that can be display in the Google Earth software. The user can set the size of the product size, a logo and a legend to the product. Furthemore, to obtain a product that fits the relief, a DEM can be used.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output Kmz product directory (with .kmz extension). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesize <int32> Size of the tiles in the kmz product, in number of pixels.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -logo <string> Path to the image logo to add to the KMZ product.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -legend <string> Path to the image legend to add to the KMZ product.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Conversion

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract2.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: otbKmzExport.kmz

                                                                                                                                                                                                                                                                                                                                                                    • logo: otb_big.png

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    KmzExport

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Export the input image in a KMZ product.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    KMZ,Export

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application exports the input image in a kmz product that can be display in the Google Earth software. The user can set the size of the product size, a logo and a legend to the product. Furthemore, to obtain a product that fits the relief, a DEM can be used.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output Kmz product directory (with .kmz extension). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesize <int32> Size of the tiles in the kmz product, in number of pixels (default = 512).. Mandatory: False. Default Value: "512"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -logo <string> Path to the image logo to add to the KMZ product.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -legend <string> Path to the image legend to add to the KMZ product.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Conversion

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract2.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: otbKmzExport.kmz

                                                                                                                                                                                                                                                                                                                                                                    • logo: otb_big.png

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/LSMSSegmentation.html b/python/plugins/processing/algs/otb/description/doc/LSMSSegmentation.html index 6d07dcf1551..03151c9dd5f 100644 --- a/python/plugins/processing/algs/otb/description/doc/LSMSSegmentation.html +++ b/python/plugins/processing/algs/otb/description/doc/LSMSSegmentation.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    LSMSSegmentation

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Second step of the exact Large-Scale Mean-Shift segmentation workflow.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Segmentation,LSMS

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs the second step of the exact Large-Scale Mean-Shift segmentation workflow (LSMS). Filtered range image and spatial image should be created with the MeanShiftSmoothing application, with modesearch parameter disabled. If spatial image is not set, the application will only process the range image and spatial radius parameter will not be taken into account. This application will produce a labeled image where neighbor pixels whose range distance is below range radius (and optionally spatial distance below spatial radius) will be grouped together into the same cluster. For large images one can use the nbtilesx and nbtilesy parameters for tile-wise processing, with the guarantees of identical results. Please note that this application will generate a lot of temporary files (as many as the number of tiles), and will therefore require twice the size of the final result in term of disk space. The cleanup option (activated by default) allows removing all temporary file as soon as they are not needed anymore (if cleanup is activated, tmpdir set and tmpdir does not exists before running the application, it will be removed as well during cleanup). The tmpdir option allows defining a directory where to write the temporary files. Please also note that the output image type should be set to uint32 to ensure that there are enough labels available.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The filtered image (cf. Adaptive MeanShift Smoothing application).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inpos <string> The spatial image. Spatial input is the displacement map (output of the Adaptive MeanShift Smoothing application).. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> The output image. The output image is the segmentation of the filtered image. It is recommended to set the pixel type to uint32.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: False. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -spatialr <float> Spatial radius of the neighborhood.. Mandatory: False. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -minsize <int32> Minimum Region Size. If, after the segmentation, a region is of size lower than this criterion, the region is deleted.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesizex <int32> Size of tiles along the X-axis.. Mandatory: True. Default Value: "500"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesizey <int32> Size of tiles along the Y-axis.. Mandatory: True. Default Value: "500"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tmpdir <string> This applications need to write temporary files for each tile. This parameter allows choosing the path where to write those files. If disabled, the current path will be used.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -cleanup <boolean> If activated, the application will try to clean all temporary files it created. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    This application is part of the Large-Scale Mean-Shift segmentation workflow (LSMS) and may not be suited for any other purpose.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    David Youssefi

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    MeanShiftSmoothing, LSMSSmallRegionsMerging, LSMSVectorization

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: smooth.tif

                                                                                                                                                                                                                                                                                                                                                                    • inpos: position.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: segmentation.tif

                                                                                                                                                                                                                                                                                                                                                                    • ranger: 15

                                                                                                                                                                                                                                                                                                                                                                    • spatialr: 5

                                                                                                                                                                                                                                                                                                                                                                    • minsize: 0

                                                                                                                                                                                                                                                                                                                                                                    • tilesizex: 256

                                                                                                                                                                                                                                                                                                                                                                    • tilesizey: 256

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    LSMSSegmentation

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Second step of the exact Large-Scale Mean-Shift segmentation workflow.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Segmentation,LSMS

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs the second step of the exact Large-Scale Mean-Shift segmentation workflow (LSMS). Filtered range image and spatial image should be created with the MeanShiftSmoothing application, with modesearch parameter disabled. If spatial image is not set, the application will only process the range image and spatial radius parameter will not be taken into account. This application will produce a labeled image where neighbor pixels whose range distance is below range radius (and optionally spatial distance below spatial radius) will be grouped together into the same cluster. For large images one can use the nbtilesx and nbtilesy parameters for tile-wise processing, with the guarantees of identical results. Please note that this application will generate a lot of temporary files (as many as the number of tiles), and will therefore require twice the size of the final result in term of disk space. The cleanup option (activated by default) allows to remove all temporary file as soon as they are not needed anymore (if cleanup is activated, tmpdir set and tmpdir does not exists before running the application, it will be removed as well during cleanup). The tmpdir option allows to define a directory where to write the temporary files. Please also note that the output image type should be set to uint32 to ensure that there are enough labels available.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The filtered image (cf. Adaptive MeanShift Smoothing application).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inpos <string> The spatial image. Spatial input is the displacement map (output of the Adaptive MeanShift Smoothing application).. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> The output image. The output image is the segmentation of the filtered image. It is recommended to set the pixel type to uint32.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: False. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -spatialr <float> Spatial radius of the neighborhood.. Mandatory: False. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -minsize <int32> Minimum Region Size. If, after the segmentation, a region is of size lower than this criterion, the region is deleted.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesizex <int32> Size of tiles along the X-axis.. Mandatory: True. Default Value: "500"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tilesizey <int32> Size of tiles along the Y-axis.. Mandatory: True. Default Value: "500"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -tmpdir <string> This applications need to write temporary files for each tile. This parameter allows choosing the path where to write those files. If disabled, the current path will be used.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -cleanup <boolean> If activated, the application will try to clean all temporary files it created. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    This application is part of the Large-Scale Mean-Shift segmentation workflow (LSMS) and may not be suited for any other purpose.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    David Youssefi

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    MeanShiftSmoothing, LSMSSmallRegionsMerging, LSMSVectorization

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: smooth.tif

                                                                                                                                                                                                                                                                                                                                                                    • inpos: position.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: segmentation.tif

                                                                                                                                                                                                                                                                                                                                                                    • ranger: 15

                                                                                                                                                                                                                                                                                                                                                                    • spatialr: 5

                                                                                                                                                                                                                                                                                                                                                                    • minsize: 0

                                                                                                                                                                                                                                                                                                                                                                    • tilesizex: 256

                                                                                                                                                                                                                                                                                                                                                                    • tilesizey: 256

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/LineSegmentDetection.html b/python/plugins/processing/algs/otb/description/doc/LineSegmentDetection.html index 10340d3482c..effe3628ac5 100644 --- a/python/plugins/processing/algs/otb/description/doc/LineSegmentDetection.html +++ b/python/plugins/processing/algs/otb/description/doc/LineSegmentDetection.html @@ -3,5 +3,5 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                    LineSegmentDetection

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Detect line segments in raster

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application detects locally straight contours in a image. It is based on Burns, Hanson, and Riseman method and use an a contrario validation approach (Desolneux, Moisan, and Morel). The algorithm was published by Rafael Gromponevon Gioi, Jérémie Jakubowicz, Jean-Michel Morel and Gregory Randall. - The given approach computes gradient and level lines of the image and detects aligned points in line support region. The application allows exporting the detected lines in a vector data.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image on which lines will be detected.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output detected line segments (vector data).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -norescale <boolean> By default, the input image amplitude is rescaled between [0,255]. Turn on this parameter to skip rescaling. Mandatory: False. Default Value: "True"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    On Line demonstration of the LSD algorithm is available here: http://www.ipol.im/pub/algo/gjmr_line_segment_detector/ + The given approach computes gradient and level lines of the image and detects aligned points in line support region. The application allows to export the detected lines in a vector data.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image on which lines will be detected.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output detected line segments (vector data).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -norescale <boolean> By default, the input image amplitude is rescaled between [0,255]. Turn on this parameter to skip rescaling. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    On Line demonstration of the LSD algorithm is available here: http://www.ipol.im/pub/algo/gjmr_line_segment_detector/

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_Suburb.png

                                                                                                                                                                                                                                                                                                                                                                    • out: LineSegmentDetection.shp

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/LocalStatisticExtraction.html b/python/plugins/processing/algs/otb/description/doc/LocalStatisticExtraction.html index 390f34a9f12..6ff7bc151aa 100644 --- a/python/plugins/processing/algs/otb/description/doc/LocalStatisticExtraction.html +++ b/python/plugins/processing/algs/otb/description/doc/LocalStatisticExtraction.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    LocalStatisticExtraction

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Computes local statistical moments on every pixel in the selected channel of the input image

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Statistics,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application computes the 4 local statistical moments on every pixel in the selected channel of the input image, over a specified neighborhood. The output image is multi band with one statistical moment (feature) per band. Thus, the 4 output features are the Mean, the Variance, the Skewness and the Kurtosis. They are provided in this exact order in the output image.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -radius <int32> The computational window radius.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing the local statistical moments.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    otbRadiometricMomentsImageFunction class

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                    • channel: 1

                                                                                                                                                                                                                                                                                                                                                                    • radius: 3

                                                                                                                                                                                                                                                                                                                                                                    • out: Statistics.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    LocalStatisticExtraction

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Computes local statistical moments on every pixel in the selected channel of the input image

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Statistics,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application computes the 4 local statistical moments on every pixel in the selected channel of the input image, over a specified neighborhood. The output image is multi band with one statistical moment (feature) per band. Thus, the 4 output features are the Mean, the Variance, the Skewness and the Kurtosis. They are provided in this exact order in the output image.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -radius <int32> The computational window radius.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image containing the local statistical moments.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    otbRadiometricMomentsImageFunction class

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                    • channel: 1

                                                                                                                                                                                                                                                                                                                                                                    • radius: 3

                                                                                                                                                                                                                                                                                                                                                                    • out: Statistics.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/MaximumAutocorrelationFactor.html b/python/plugins/processing/algs/otb/description/doc/MaximumAutocorrelationFactor.html deleted file mode 100644 index eeaa31ccac6..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/MaximumAutocorrelationFactor.html +++ /dev/null @@ -1 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                    Maximum autocorrelation factor filter

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Performs Kernel maximum autocorrelation factor transformationMaximum autocorrelation factor filter.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Dimensionality Reduction, Image Filtering

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application calculates the Maximum Autocorrelation Factor based on A. Nielsen works ("Kernel maximum autocorrelation factor and minimum noise fraction transformations," IEEE Transactions on Image Processing, vol. 20, no. 3, pp. 612-624, (2011)).Maximum Autocorrelation Factor can be considered as a spatial extension of the PCA.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] Input Image (-in):

                                                                                                                                                                                                                                                                                                                                                                    • [param] Change Map (-out):

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    Though the inverse transform can be computed, this filter only provides the forward transform for now.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                      • Input Image: cupriteSubHsi.tif

                                                                                                                                                                                                                                                                                                                                                                      • Change Map: MaximumAutocorrelationFactorImageFilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                      • otbcli_MaximumAutocorrelationFactor -in cupriteSubHsi.tif -out MaximumAutocorrelationFactorImageFilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentation.html b/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentation.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentation.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                    4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                    Detailed description
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                    To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                    Parameter key

                                                                                                                                                                                                                                                                                                                                                                    		Parameter type

                                                                                                                                                                                                                                                                                                                                                                    Parameter description

                                                                                                                                                                                                                                                                                                                                                                    in

                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                    Input Image

                                                                                                                                                                                                                                                                                                                                                                    filter

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                    filter meanshift

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                    filter edison

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                    filter cc

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Connected components

                                                                                                                                                                                                                                                                                                                                                                    filter watershed

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Watershed

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Scale factor

                                                                                                                                                                                                                                                                                                                                                                    filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Condition

                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Flood Level

                                                                                                                                                                                                                                                                                                                                                                    mode

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Processing mode

                                                                                                                                                                                                                                                                                                                                                                    mode vector

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                    mode raster

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                    		Output File name

                                                                                                                                                                                                                                                                                                                                                                    Output vector file

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                    Mask Image

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                    8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                    Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum object size

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Layer name

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Tiles size

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                    		String list

                                                                                                                                                                                                                                                                                                                                                                    OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                    mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                    		Output image

                                                                                                                                                                                                                                                                                                                                                                    Output labeled image

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Examples
                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                    Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Limitations
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                    Authors
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                    See also
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                    - diff --git a/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentationVector.html b/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentationVector.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/MeanShiftSegmentationVector.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                    4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                    Detailed description
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                    To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                    Parameter key

                                                                                                                                                                                                                                                                                                                                                                    		Parameter type

                                                                                                                                                                                                                                                                                                                                                                    Parameter description

                                                                                                                                                                                                                                                                                                                                                                    in

                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                    Input Image

                                                                                                                                                                                                                                                                                                                                                                    filter

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                    filter meanshift

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                    filter edison

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                    filter cc

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Connected components

                                                                                                                                                                                                                                                                                                                                                                    filter watershed

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Watershed

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                    filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Scale factor

                                                                                                                                                                                                                                                                                                                                                                    filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Condition

                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Flood Level

                                                                                                                                                                                                                                                                                                                                                                    mode

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Processing mode

                                                                                                                                                                                                                                                                                                                                                                    mode vector

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                    mode raster

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                    		Output File name

                                                                                                                                                                                                                                                                                                                                                                    Output vector file

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                    Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                    Mask Image

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                    8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                    Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Minimum object size

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                    Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Layer name

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                    Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Tiles size

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                    Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                    mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                    		String list

                                                                                                                                                                                                                                                                                                                                                                    OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                    mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                    		Output image

                                                                                                                                                                                                                                                                                                                                                                    Output labeled image

                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                      • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                    • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                      • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Examples
                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                    Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    Limitations
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                    Authors
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                    See also
                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                    These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                    • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                    - diff --git a/python/plugins/processing/algs/otb/description/doc/MeanShiftSmoothing.html b/python/plugins/processing/algs/otb/description/doc/MeanShiftSmoothing.html index c27e3649e34..491953882a8 100644 --- a/python/plugins/processing/algs/otb/description/doc/MeanShiftSmoothing.html +++ b/python/plugins/processing/algs/otb/description/doc/MeanShiftSmoothing.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    MeanShiftSmoothing

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Perform mean shift filtering

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Image Filtering

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs mean shift fitlering (multi-threaded).

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -fout <string> The filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: False. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -modesearch <boolean> If activated pixel iterative convergence is stopped if the path . Be careful, with this option, the result will slightly depend on thread number. Mandatory: False. Default Value: "True"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    With mode search option, the result will slightly depend on thread number.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: maur_rgb.png

                                                                                                                                                                                                                                                                                                                                                                    • fout: MeanShift_FilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    • spatialr: 16

                                                                                                                                                                                                                                                                                                                                                                    • ranger: 16

                                                                                                                                                                                                                                                                                                                                                                    • thres: 0.1

                                                                                                                                                                                                                                                                                                                                                                    • maxiter: 100

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    MeanShiftSmoothing

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Perform mean shift filtering

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Image Filtering,LSMS

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application performs mean shift fitlering (multi-threaded).

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -fout <string> The filtered output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -foutpos <string> The spatial image output. Spatial image output is a displacement map (pixel position after convergence).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -spatialr <int32> Spatial radius of the neighborhood.. Mandatory: False. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: False. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: False. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -rangeramp <float> This coefficient makes dependent the ranger of the colorimetry of the filtered pixel : y = rangeramp*x+ranger.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -modesearch <boolean> If activated pixel iterative convergence is stopped if the path . Be careful, with this option, the result will slightly depend on thread number. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    With mode search option, the result will slightly depend on thread number.

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: maur_rgb.png

                                                                                                                                                                                                                                                                                                                                                                    • fout: MeanShift_FilterOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    • foutpos: MeanShift_SpatialOutput.tif

                                                                                                                                                                                                                                                                                                                                                                    • spatialr: 16

                                                                                                                                                                                                                                                                                                                                                                    • ranger: 16

                                                                                                                                                                                                                                                                                                                                                                    • thres: 0.1

                                                                                                                                                                                                                                                                                                                                                                    • maxiter: 100

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/MultiResolutionPyramid.html b/python/plugins/processing/algs/otb/description/doc/MultiResolutionPyramid.html index 2642450f6d2..bfae5161dcd 100644 --- a/python/plugins/processing/algs/otb/description/doc/MultiResolutionPyramid.html +++ b/python/plugins/processing/algs/otb/description/doc/MultiResolutionPyramid.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                    MultiResolutionPyramid

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Build a multi-resolution pyramid of the image.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Conversion,Image Manipulation,Image MultiResolution,Util

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application builds a multi-resolution pyramid of the input image. User can specified the number of levels of the pyramid and the subsampling factor. To speed up the process, you can use the fast scheme option

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> will be used to get the prefix and the extension of the images to write. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -level <int32> Number of levels in the pyramid (default is 1).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -sfactor <int32> Subsampling factor between each level of the pyramid (default is 2).. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -vfactor <float> Variance factor use in smoothing. It is multiplied by the subsampling factor of each level in the pyramid (default is 0.6).. Mandatory: True. Default Value: "0.6"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -fast <boolean> If used, this option allows speeding up computation by iteratively subsampling previous level of pyramid instead of processing the full input.. Mandatory: False. Default Value: "True"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: multiResolutionImage.tif

                                                                                                                                                                                                                                                                                                                                                                    • level: 1

                                                                                                                                                                                                                                                                                                                                                                    • sfactor: 2

                                                                                                                                                                                                                                                                                                                                                                    • vfactor: 0.6

                                                                                                                                                                                                                                                                                                                                                                    • fast: false

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                    MultiResolutionPyramid

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Build a multi-resolution pyramid of the image.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Conversion,Image Manipulation,Image MultiResolution,Util

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application builds a multi-resolution pyramid of the input image. User can specified the number of levels of the pyramid and the subsampling factor. To speed up the process, you can use the fast scheme option

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> will be used to get the prefix and the extension of the images to write. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -level <int32> Number of levels in the pyramid (default is 1).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -sfactor <int32> Subsampling factor between each level of the pyramid (default is 2).. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -vfactor <float> Variance factor use in smoothing. It is multiplied by the subsampling factor of each level in the pyramid (default is 0.6).. Mandatory: True. Default Value: "0.6"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -fast <boolean> If used, this option allows to speed-up computation by iteratively subsampling previous level of pyramid instead of processing the full input.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                    • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                    • out: multiResolutionImage.tif

                                                                                                                                                                                                                                                                                                                                                                    • level: 1

                                                                                                                                                                                                                                                                                                                                                                    • sfactor: 2

                                                                                                                                                                                                                                                                                                                                                                    • vfactor: 0.6

                                                                                                                                                                                                                                                                                                                                                                    • fast: false

                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/MultivariateAlterationDetector.html b/python/plugins/processing/algs/otb/description/doc/MultivariateAlterationDetector.html index 06acfee94c0..989f13d3db3 100644 --- a/python/plugins/processing/algs/otb/description/doc/MultivariateAlterationDetector.html +++ b/python/plugins/processing/algs/otb/description/doc/MultivariateAlterationDetector.html @@ -2,7 +2,7 @@ -

                                                                                                                                                                                                                                                                                                                                                                    MultivariateAlterationDetector

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Multivariate Alteration Detector

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application detects change between two given images.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in1 <string> Image which describe initial state of the scene.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -in2 <string> Image which describe scene after perturbations.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Image of detected changes.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    This filter implements the Multivariate Alteration Detector, based on the following work: +

                                                                                                                                                                                                                                                                                                                                                                    MultivariateAlterationDetector

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Multivariate Alteration Detector

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application detects change between two given images.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -in1 <string> Image which describe initial state of the scene.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -in2 <string> Image which describe scene after perturbations.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Image of detected changes.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                    This filter implements the Multivariate Alteration Detector, based on the following work: A. A. Nielsen and K. Conradsen, Multivariate alteration detection (mad) in multispectral, bi-temporal image data: a new approach to change detection studies, Remote Sens. Environ., vol. 64, pp. 1-19, (1998) Multivariate Alteration Detector takes two images as inputs and produce a set of N change maps as a VectorImage (where N is the maximum of number of bands in first and second image) with the following properties: @@ -13,7 +13,7 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; t If numbers of bands in image 1 and 2 are equal, then change maps are sorted by increasing correlation. If number of bands is different, the change maps are sorted by decreasing correlation. - The GetV1() and GetV2() methods allow to retrieve the linear combinations used to generate the Mad change maps as a vnl_matrix of double, and the GetRho() method allows retrieving the correlation associated to each Mad change maps as a vnl_vector. + The GetV1() and GetV2() methods allow to retrieve the linear combinations used to generate the Mad change maps as a vnl_matrix of double, and the GetRho() method allows to retrieve the correlation associated to each Mad change maps as a vnl_vector. This filter has been implemented from the Matlab code kindly made available by the authors here: http://www2.imm.dtu.dk/~aa/software.html diff --git a/python/plugins/processing/algs/otb/description/doc/OGRLayerClassifier.html b/python/plugins/processing/algs/otb/description/doc/OGRLayerClassifier.html new file mode 100644 index 00000000000..9b8b14bf2ff --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/OGRLayerClassifier.html @@ -0,0 +1,5 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                    OGRLayerClassifier

                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                    Classify an OGR layer based on a machine learning model and a list of features to consider.

                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                    Segmentation

                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                    This application will apply a trained machine learning model on the selected feature to get a classification of each geometry contained in an OGR layer. The list of feature must match the list used for training. The predicted label is written in the user defined field for each geometry.

                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                    • [param] -inshp <string> Name of the input shapefile. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -instats <string> XML file containing mean and variance of each feature.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -insvm <string> Input model filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -cfield <string> Field containing the predicted class. Mandatory: True. Default Value: "predicted"
                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [choice] -feat Features to be calculated . Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                      Experimental. Only shapefiles are supported for now.

                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                      David Youssefi during internship at CNES

                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                      ComputeOGRLayersFeaturesStatistics,TrainOGRLayersClassifier

                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                      • inshp: vectorData.shp

                                                                                                                                                                                                                                                                                                                                                                      • instats: meanVar.xml

                                                                                                                                                                                                                                                                                                                                                                      • insvm: svmModel.svm

                                                                                                                                                                                                                                                                                                                                                                      • feat: perimeter

                                                                                                                                                                                                                                                                                                                                                                      • cfield: predicted

                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OSMDownloader.html b/python/plugins/processing/algs/otb/description/doc/OSMDownloader.html index d77c9cf542a..83bacfab606 100644 --- a/python/plugins/processing/algs/otb/description/doc/OSMDownloader.html +++ b/python/plugins/processing/algs/otb/description/doc/OSMDownloader.html @@ -2,5 +2,5 @@ -

                                                                                                                                                                                                                                                                                                                                                                      OSMDownloader

                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                      Generate a vector data from OSM on the input image extend

                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                      Image MetaData

                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                      Generate a vector data from Open Street Map data. A DEM could be use. By default, the entire layer is downloaded, an image can be use as support for the OSM data. The application can provide also available classes in layers . This application required an Internet access. Information about the OSM project : http://www.openstreetmap.org/

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • [param] -out <string> Generated output vector data path. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -support <string> Image used as support to estimate the models. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -key <string> OSM tag key to extract (highway, building...). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -value <string> OSM tag value to extract (motorway, footway...). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -printclasses <boolean> Print the key/value classes available for the bounding box of the input image - ** If not used : Note that the options OSMKey (-key) and Output (-out) become mandatory. Mandatory: False. Default Value: "True"

                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                      Convertion

                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                      • support: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                      • key: highway

                                                                                                                                                                                                                                                                                                                                                                      • out: apTvUtOSMDownloader.shp

                                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                                      OSMDownloader

                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                      Generate a vector data from OSM on the input image extend

                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                      Image MetaData

                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                      Generate a vector data from Open Street Map data. A DEM could be use. By default, the entire layer is downloaded, an image can be use as support for the OSM data. The application can provide also available classes in layers . This application required an Internet access. Informations about the OSM project : http://www.openstreetmap.fr/

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • [param] -out <string> Generated output vector data path. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -support <string> Image used as support to estimate the models. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -key <string> OSM tag key to extract (highway, building...). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -value <string> OSM tag value to extract (motorway, footway...). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -printclasses <boolean> Print the key/value classes available for the bounding box of the input image + ** If not used : Note that the options OSMKey (-key) and Output (-out) become mandatory. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                      Convertion

                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                      • support: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                      • key: highway

                                                                                                                                                                                                                                                                                                                                                                      • out: apTvUtOSMDownloader.shp

                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ObtainUTMZoneFromGeoPoint.html b/python/plugins/processing/algs/otb/description/doc/ObtainUTMZoneFromGeoPoint.html index fba3ce36554..eb416fdd3d8 100644 --- a/python/plugins/processing/algs/otb/description/doc/ObtainUTMZoneFromGeoPoint.html +++ b/python/plugins/processing/algs/otb/description/doc/ObtainUTMZoneFromGeoPoint.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                      ObtainUTMZoneFromGeoPoint

                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                      UTM zone determination from a geographic point.

                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                      Coordinates

                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                      This application returns the UTM zone of an input geographic point.

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • [param] -lat <float> Latitude value of desired point.. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -lon <float> Longitude value of desired point.. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -utm <int32> UTM Zone. Mandatory: False. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                      Obtain a UTM Zone

                                                                                                                                                                                                                                                                                                                                                                      • lat: 10.0

                                                                                                                                                                                                                                                                                                                                                                      • lon: 124.0

                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                      ObtainUTMZoneFromGeoPoint

                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                      UTM zone determination from a geographic point.

                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                      Coordinates

                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                      This application returns the UTM zone of an input geographic point.

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • [param] -lat <float> Latitude value of desired point.. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -lon <float> Longitude value of desired point.. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -utm <int32> UTM Zone. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                      Obtain a UTM Zone

                                                                                                                                                                                                                                                                                                                                                                      • lat: 10.0

                                                                                                                                                                                                                                                                                                                                                                      • lon: 124.0

                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OpticalCalibration.html b/python/plugins/processing/algs/otb/description/doc/OpticalCalibration.html index 27d3eda38de..574f89dc454 100644 --- a/python/plugins/processing/algs/otb/description/doc/OpticalCalibration.html +++ b/python/plugins/processing/algs/otb/description/doc/OpticalCalibration.html @@ -2,9 +2,59 @@ -

                                                                                                                                                                                                                                                                                                                                                                      OpticalCalibration

                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                      Perform optical calibration TOA/TOC (Top Of Atmosphere/Top Of Canopy). Supported sensors: QuickBird, Ikonos, WorldView2, Formosat, Spot5, Pleiades

                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                      Calibration

                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                      The application allows converting pixel values from DN (for Digital Numbers) to physically interpretable and comparable values. Calibrated values are called surface reflectivity and its values lie in the range [0, 1]. -The first level is called Top Of Atmosphere (TOA) reflectivity. It takes into account the sensor gain, sensor spectral response and the solar illumination. -The second level is called Top Of Canopy (TOC) reflectivity. In addition to sensor gain and solar illumination, it takes into account the optical thickness of the atmosphere, the atmospheric pressure, the water vapor amount, the ozone amount, as well as the composition and amount of aerosol gasses. -It is also possible to indicate an AERONET file which contains atmospheric parameters (version 1 and version 2 of Aeronet file are supported.

                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                      • [param] -in <string> Input image filename (values in DN). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -out <string> Output calibrated image filename. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -milli <boolean> Flag to use milli-reflectance instead of reflectance. -This allows saving the image with integer pixel type (in the range [0, 1000] instead of floating point in the range [0, 1]. In order to do that, use this option and set the output pixel type (-out filename uint16 for example). Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -clamp <boolean> Clamping in the range [0, 100]. It can be useful to preserve area with specular reflectance.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -rsr <string> Sensor relative spectral response file -By default the application gets these information in the metadata. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                      • [param] -atmo <string> This group allows setting the atmospheric parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                      • [param] -radius <int32> Window radius for adjacency effects corrections. Mandatory: False. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                        • [choice] -level toa,toc. Mandatory: True. Default Value: "toa"
                                                                                                                                                                                                                                                                                                                                                                        • [group] -toa
                                                                                                                                                                                                                                                                                                                                                                          • [group] -toc

                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                          The OTB CookBook

                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                          • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                          • level: toa

                                                                                                                                                                                                                                                                                                                                                                          • out: OpticalCalibration.tif

                                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                                          OpticalCalibration

                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                          Perform optical calibration TOA/TOC (Top Of Atmosphere/Top Of Canopy). Supported sensors: QuickBird, Ikonos, WorldView2, Formosat, Spot5, Pleiades, Spot6. For other sensors the application also allows to provide calibration parameters manually.

                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                          Calibration

                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                          The application allows to convert pixel values from DN (for Digital Numbers) to reflectance. Calibrated values are called surface reflectivity and its values lie in the range [0, 1]. +The first level is called Top Of Atmosphere (TOA) reflectivity. It takes into account the sensor gain, sensor spectral response and the solar illuminations. +The second level is called Top Of Canopy (TOC) reflectivity. In addition to sensor gain and solar illuminations, it takes into account the optical thickness of the atmosphere, the atmospheric pressure, the water vapor amount, the ozone amount, as well as the composition and amount of aerosol gasses. +It is also possible to indicate an AERONET file which contains atmospheric parameters (version 1 and version 2 of Aeronet file are supported. Note that computing TOC reflectivity will internally compute first TOA and then TOC reflectance. + +-------------------------- + +If the sensor is not supported by the metadata interface factory of OTB, users still have the possibility to give the needed parameters to the application. +For TOA conversion, these parameters are : +- day and month of acquisition, or flux normalization coefficient; +- sun elevation angle; +- gains and biases, one pair of values for each band (passed by a file); +- solar illuminations, one value for each band (passed by a file). + +For the conversion from DN (for Digital Numbers) to spectral radiance (or 'TOA radiance') L, the following formula is used : + +(1) L(b) = DN(b)/gain(b)+bias(b) (in W/m2/steradians/micrometers) with b being a band ID. + +These values are provided by the user thanks to a simple txt file with two lines, one for the gains and one for the biases. +Each value must be separated with colons (:), with eventual spaces. Blank lines are not allowed. If a line begins with the '#' symbol, then it is considered as comments. +Note that sometimes, the values provided by certain metadata files assume the formula L(b) = gain(b)*DC(b)+bias(b). +In this case, be sure to provide the inverse gain values so that the application can correctly interpret them. + +In order to convert TOA radiance to TOA reflectance, the following formula is used : + +(2) R(b) = (pi*L(b)*d*d) / (ESUN(b)*cos(θ)) (no dimension) where : + +- L(b) is the spectral radiance for band b +- pi is the famous mathematical constant (3.14159...) +- d is the earth-sun distance (in astronomical units) and depends on the acquisition's day and month +- ESUN(b) is the mean TOA solar irradiance (or solar illumination) in W/m²/micrometers +- θ is the solar zenith angle in degrees. +Note that the application asks for the solar elevation angle, and will perfom the conversion to the zenith angle itself (ze. angle = 90° - el. angle). +Note also that ESUN(b) not only depends on the band b, but also on the spectral sensitivity of the sensor in this particular band. In other words, the influence of spectral sensitivities is included within the ESUN different values. +These values are provided by the user thanks to a txt file following the same convention as before. +Instead of providing the date of acquisition, the user can also provide a flux normalization coefficient 'fn'. The formula used instead will be the following : + +(3) R(b) = (pi*L(b)) / (ESUN(b)*fn*fn*cos(θ)) + +Whatever the formula used (2 or 3), the user should pay attention to the interpretation of the parameters he will provide to the application, by taking into account the original formula that the metadata files assumes. + +Below, we give two examples of txt files containing information about gains/biases and solar illuminations : + +- gainbias.txt : +# Gain values for each band. Each value must be separated with colons (:), with eventual spaces. Blank lines not allowed. +10.4416 : 9.529 : 8.5175 : 14.0063 +# Bias values for each band. +0.0 : 0.0 : 0.0 : 0.0 + +- solarillumination.txt : +# Solar illumination values in watt/m2/micron ('micron' means actually 'for each band'). +# Each value must be separated with colons (:), with eventual spaces. Blank lines not allowed. +1540.494123 : 1826.087443 : 1982.671954 : 1094.747446 + +Finally, the 'Logs' tab provides usefull messages that can help the user in knowing the process different status.

                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                          • [param] -in <string> Input image filename (values in DN). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                          • [param] -out <string> Output calibrated image filename. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                          • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                          • [param] -milli <boolean> Flag to use milli-reflectance instead of reflectance. +This allows to save the image with integer pixel type (in the range [0, 1000] instead of floating point in the range [0, 1]. In order to do that, use this option and set the output pixel type (-out filename double for example). Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                          • [param] -clamp <boolean> Clamping in the range [0, 100]. It can be useful to preserve area with specular reflectance.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                          • [param] -acqui <string> This group allows to set the parameters related to the acquisition conditions.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                          • [param] -atmo <string> This group allows to set the atmospheric parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                            • [choice] -level toa,toatoim,toc. Mandatory: True. Default Value: "toa"
                                                                                                                                                                                                                                                                                                                                                                            • [group] -toa
                                                                                                                                                                                                                                                                                                                                                                              • [group] -toatoim
                                                                                                                                                                                                                                                                                                                                                                                • [group] -toc

                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                The OTB CookBook

                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                • level: toa

                                                                                                                                                                                                                                                                                                                                                                                • out: OpticalCalibration.tif

                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-epsg.html b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-epsg.html index 5a78719e808..33b0964d8c6 100644 --- a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-epsg.html +++ b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-epsg.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                This application allows ortho-rectifying optical images from supported sensors. +

                                                                                                                                                                                                                                                                                                                                                                                OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                This application allows to ortho-rectify optical images from supported sensors.

                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                Geometry

                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                An inverse sensor model is built from the input image metadata to convert geographical to raw geometry coordinates. This inverse sensor model is then combined with the chosen map projection to build a global coordinate mapping grid. Last, this grid is used to resample using the chosen interpolation algorithm. A Digital Elevation Model can be specified to account for terrain deformations. -In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                • [param] -outputs <string> This group of parameters allows defining the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                • [param] -opt <string> This group of parameters allows optimizing processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                  • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                  • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                      • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                        • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                        [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                        • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                        • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                          • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                          Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                          Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                          • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                          • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                          +In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outputs <string> This group of parameters allows to define the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -opt <string> This group of parameters allows to optimize processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                            • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                              • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                              • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                            • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                              • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                  [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                    Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                    Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                    • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                    • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-fit-to-ortho.html b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-fit-to-ortho.html index 5a78719e808..33b0964d8c6 100644 --- a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-fit-to-ortho.html +++ b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-fit-to-ortho.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                    OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                    This application allows ortho-rectifying optical images from supported sensors. +

                                                                                                                                                                                                                                                                                                                                                                                                    OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to ortho-rectify optical images from supported sensors.

                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                    Geometry

                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                    An inverse sensor model is built from the input image metadata to convert geographical to raw geometry coordinates. This inverse sensor model is then combined with the chosen map projection to build a global coordinate mapping grid. Last, this grid is used to resample using the chosen interpolation algorithm. A Digital Elevation Model can be specified to account for terrain deformations. -In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outputs <string> This group of parameters allows defining the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -opt <string> This group of parameters allows optimizing processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                      • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                            [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                              Limitations

                                                                                                                                                                                                                                                                                                                                                                                                              Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                              Authors

                                                                                                                                                                                                                                                                                                                                                                                                              OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                              See Also

                                                                                                                                                                                                                                                                                                                                                                                                              Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                              Example of use

                                                                                                                                                                                                                                                                                                                                                                                                              • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                              • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                              +In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -outputs <string> This group of parameters allows to define the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -opt <string> This group of parameters allows to optimize processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                      [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                        Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                        Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                        • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                        • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-lambert-WGS84.html b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-lambert-WGS84.html index 5a78719e808..33b0964d8c6 100644 --- a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-lambert-WGS84.html +++ b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-lambert-WGS84.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                        OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                        This application allows ortho-rectifying optical images from supported sensors. +

                                                                                                                                                                                                                                                                                                                                                                                                                        OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                        This application allows to ortho-rectify optical images from supported sensors.

                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                        Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                        An inverse sensor model is built from the input image metadata to convert geographical to raw geometry coordinates. This inverse sensor model is then combined with the chosen map projection to build a global coordinate mapping grid. Last, this grid is used to resample using the chosen interpolation algorithm. A Digital Elevation Model can be specified to account for terrain deformations. -In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outputs <string> This group of parameters allows defining the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -opt <string> This group of parameters allows optimizing processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                  Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                  Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                  +In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outputs <string> This group of parameters allows to define the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -opt <string> This group of parameters allows to optimize processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                          [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                            Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                            Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                            • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                            • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-utm.html b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-utm.html index 5a78719e808..33b0964d8c6 100644 --- a/python/plugins/processing/algs/otb/description/doc/OrthoRectification-utm.html +++ b/python/plugins/processing/algs/otb/description/doc/OrthoRectification-utm.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                            OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows ortho-rectifying optical images from supported sensors. +

                                                                                                                                                                                                                                                                                                                                                                                                                                            OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to ortho-rectify optical images from supported sensors.

                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                            Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                            An inverse sensor model is built from the input image metadata to convert geographical to raw geometry coordinates. This inverse sensor model is then combined with the chosen map projection to build a global coordinate mapping grid. Last, this grid is used to resample using the chosen interpolation algorithm. A Digital Elevation Model can be specified to account for terrain deformations. -In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outputs <string> This group of parameters allows defining the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -opt <string> This group of parameters allows optimizing processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                      +In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outputs <string> This group of parameters allows to define the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -opt <string> This group of parameters allows to optimize processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/OrthoRectification.html b/python/plugins/processing/algs/otb/description/doc/OrthoRectification.html index 5a78719e808..33b0964d8c6 100644 --- a/python/plugins/processing/algs/otb/description/doc/OrthoRectification.html +++ b/python/plugins/processing/algs/otb/description/doc/OrthoRectification.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows ortho-rectifying optical images from supported sensors. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                OrthoRectification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows to ortho-rectify optical images from supported sensors.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                An inverse sensor model is built from the input image metadata to convert geographical to raw geometry coordinates. This inverse sensor model is then combined with the chosen map projection to build a global coordinate mapping grid. Last, this grid is used to resample using the chosen interpolation algorithm. A Digital Elevation Model can be specified to account for terrain deformations. -In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outputs <string> This group of parameters allows defining the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -opt <string> This group of parameters allows optimizing processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          +In case of SPOT5 images, the sensor model can be approximated by an RPC model in order to speed-up computation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outputs <string> This group of parameters allows to define the grid on which the input image will be resampled.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -opt <string> This group of parameters allows to optimize processing time.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Supported sensors are Pleiades, SPOT5 (TIF format), Ikonos, Quickbird, Worldview2, GeoEye.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Ortho-rectification chapter from the OTB Software Guide

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.in: QB_TOULOUSE_MUL_Extract_500_500.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.out: QB_Toulouse_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Pansharpening-bayes.html b/python/plugins/processing/algs/otb/description/doc/Pansharpening-bayes.html index 414545c6e5b..dd25169010a 100644 --- a/python/plugins/processing/algs/otb/description/doc/Pansharpening-bayes.html +++ b/python/plugins/processing/algs/otb/description/doc/Pansharpening-bayes.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Pansharpening-lmvm.html b/python/plugins/processing/algs/otb/description/doc/Pansharpening-lmvm.html index 414545c6e5b..dd25169010a 100644 --- a/python/plugins/processing/algs/otb/description/doc/Pansharpening-lmvm.html +++ b/python/plugins/processing/algs/otb/description/doc/Pansharpening-lmvm.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Pansharpening-rcs.html b/python/plugins/processing/algs/otb/description/doc/Pansharpening-rcs.html index 414545c6e5b..dd25169010a 100644 --- a/python/plugins/processing/algs/otb/description/doc/Pansharpening-rcs.html +++ b/python/plugins/processing/algs/otb/description/doc/Pansharpening-rcs.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Pansharpening.html b/python/plugins/processing/algs/otb/description/doc/Pansharpening.html index 414545c6e5b..dd25169010a 100644 --- a/python/plugins/processing/algs/otb/description/doc/Pansharpening.html +++ b/python/plugins/processing/algs/otb/description/doc/Pansharpening.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Perform P+XS pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Geometry,Pansharpening

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs P+XS pansharpening. Pansharpening is a process of merging high-resolution panchromatic and lower resolution multispectral imagery to create a single high-resolution color image. Algorithms available in the applications are: RCS, bayesian fusion and Local Mean and Variance Matching(LMVM).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -inp <string> Input panchromatic image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -inxs <string> Input XS image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -out <string> Output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -method Selection of the pan-sharpening method. rcs,lmvm,bayes. Mandatory: True. Default Value: "rcs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rcs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -lmvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -method.lmvm.radiusx <int32> Set the x radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -method.lmvm.radiusy <int32> Set the y radius of the sliding window.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -method.bayes.lambda <float> Set the weighting value.. Mandatory: True. Default Value: "0.9999"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -method.bayes.s <float> Set the S coefficient.. Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • inp: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • inxs: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: Pansharpening.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/PixelValue.html b/python/plugins/processing/algs/otb/description/doc/PixelValue.html index ada52dc12bd..53b7cab54fc 100644 --- a/python/plugins/processing/algs/otb/description/doc/PixelValue.html +++ b/python/plugins/processing/algs/otb/description/doc/PixelValue.html @@ -3,4 +3,4 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    PixelValue

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the value of a pixel.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Utilities,Coordinates,Raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Get the value of a pixel. -Pay attention, index starts at 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -coordx <int32> Column index of the wanted pixel (starts at 0).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -coordy <int32> Line index of the wanted pixel (starts at 0).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -value <string> Pixel radiometric value. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [choice] -cl Displayed channels . Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • coordx: 50

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • coordy: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • cl: Channel1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +Pay attention, index starts at 0.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -coordx <int32> Column index of the wanted pixel (starts at 0).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -coordy <int32> Line index of the wanted pixel (starts at 0).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -value <string> Pixel radiometric value. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [choice] -cl Displayed channels . Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • coordx: 50

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • coordy: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • cl: Channel1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Quicklook.html b/python/plugins/processing/algs/otb/description/doc/Quicklook.html index 7eecc2c879f..c84a0abaf34 100644 --- a/python/plugins/processing/algs/otb/description/doc/Quicklook.html +++ b/python/plugins/processing/algs/otb/description/doc/Quicklook.html @@ -3,5 +3,5 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Quicklook

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generates a subsampled version of an image extract

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generates a subsampled version of an extract of an image defined by ROIStart and ROISize. - This extract is subsampled using the ratio OR the output image Size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -in <string> The image to read. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> The subsampled image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rox <int32> first point of ROI in x-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -roy <int32> first point of ROI in y-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rsx <int32> size of ROI in x-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rsy <int32> size of ROI in y-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sr <int32> Sampling Ratio, default is 2. Mandatory: False. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sx <int32> quicklook size in x-direction (used if no sampling ration is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sy <int32> quicklook size in y-direction (used if no sampling ration is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -cl Selected channels . Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application does not provide yet the optimal way to decode coarser level of resolution from JPEG2000 images (like in Monteverdi). + This extract is subsampled using the ratio OR the output image Size.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -in <string> The image to read. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -out <string> The subsampled image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rox <int32> first point of ROI in x-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -roy <int32> first point of ROI in y-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rsx <int32> size of ROI in x-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rsy <int32> size of ROI in y-direction. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sr <int32> Sampling Ratio, default is 2. Mandatory: False. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sx <int32> quicklook size in x-direction (used if no sampling ration is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sy <int32> quicklook size in y-direction (used if no sampling ration is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -cl Selected channels . Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application does not provide yet the optimal way to decode coarser level of resolution from JPEG2000 images (like in Monteverdi). Trying to subsampled huge JPEG200 image with the application will lead to poor performances for now.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: quicklookImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RadiometricIndices.html b/python/plugins/processing/algs/otb/description/doc/RadiometricIndices.html index c05f1b95649..9686e915d86 100644 --- a/python/plugins/processing/algs/otb/description/doc/RadiometricIndices.html +++ b/python/plugins/processing/algs/otb/description/doc/RadiometricIndices.html @@ -2,7 +2,7 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RadiometricIndices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Compute radiometric indices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Radiometric Indices,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application computes radiometric indices using the relevant channels of the input image. The output is a multi band image into which each channel is one of the selected indices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Radiometric indices output image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -channels <string> Channels selection. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -list List of available radiometric indices with their relevant channels in brackets: +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              RadiometricIndices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Compute radiometric indices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Radiometric Indices,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              This application computes radiometric indices using the relevant channels of the input image. The output is a multi band image into which each channel is one of the selected indices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -in <string> Input image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -out <string> Radiometric indices output image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -channels <string> Channels selection. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [choice] -list List of available radiometric indices with their relevant channels in brackets: Vegetation:NDVI - Normalized difference vegetation index (Red, NIR) Vegetation:TNDVI - Transformed normalized difference vegetation index (Red, NIR) Vegetation:RVI - Ratio vegetation index (Red, NIR) diff --git a/python/plugins/processing/algs/otb/description/doc/RadiometricVegetationIndices.html b/python/plugins/processing/algs/otb/description/doc/RadiometricVegetationIndices.html deleted file mode 100644 index c6ad9ec2c2d..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/RadiometricVegetationIndices.html +++ /dev/null @@ -1 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Radiometric Vegetation Application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Compute radiometric indices based on Red and NIT channels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Vegetation Indices, Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application computes radiometric indices that uses red and NIR channels of the input image. The output image is a multi channel one which each channel is one of the selected index. The channel order is the one of the selected indices.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] Input Image (-in): Input image, with at least red and NIR channels

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] Output Image (-out): Radiometric indices output image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] Available RAM (-ram): Available RAM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] Channels selection (-channels): Channels selection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] Red Channel (-red): Red channel index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] NIR Channel (-nir): NIR channel index


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] Indices selection (-index): List of available radiometric indices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] NDVI (-ndvi): Normalized Difference Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] TNDVI (-tndvi): Transformed Normalized Difference Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] RVI (-rvi): Ratio Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] SAVI (-savi): Soil Adjusted Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] TSAVI (-tsavi): Transformed Soil Adjusted Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] MSAVI (-msavi): Modified Soil Adjusted Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] MSAVI2 (-msavi2): Modified Soil Adjusted Vegetation Index 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] GEMI (-gemi): Global Environment Monitoring Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] IPVI (-ipvi): Infrared Percentage Vegetation Index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] LAIFromNDVILog (-laindvilog): Leaf Area Index from NDVI using a logarithmic relationship

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] LAIFromReflLinear (-lairefl): Leaf Area Index from reflectance using a linear relationship

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] LAIFromNDVIFormo (-laindviformo): Leaf Area Index from reflectance using using formula a*(exp(nir-red)/((red+nir)*b)-exp(c*b)), with a = 0.1519 b = 3.9443 c = 0.13. This formula is only valid for Formosat 2 reflectance TOCa linear relationship.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                otbVecgetationIndices class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Input Image: qb_RoadExtract.img

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • Output Image: RadiometricVegetationIndicesImages.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • NDVI: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • RVI: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • IPVI: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • otbcli_RadiometricVegetationIndices -in qb_RoadExtract.img -out RadiometricVegetationIndicesImages.tif -index.ndvi true -index.rvi true -index.ipvi true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Rasterization-image.html b/python/plugins/processing/algs/otb/description/doc/Rasterization-image.html new file mode 100644 index 00000000000..6de3a2fbaba --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/Rasterization-image.html @@ -0,0 +1,6 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterize a vector dataset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows to reproject and rasterize a vector dataset. The grid of the rasterized output can be set by using a reference image, or by setting all parmeters (origin, size, spacing) by hand. In the latter case, at least the spacing (ground sampling distance) is needed (other parameters are computed automatically). The rasterized output can also be in a different projection reference system than the input dataset. + There are two rasterize mode available in the application. The first is the binary mode: it allows to render all pixels belonging to a geometry of the input dataset in the foreground color, while rendering the other in background color. The second one allows to render pixels belonging to a geometry woth respect to an attribute of this geometry. The field of the attribute to render can be set by the user. In the second mode, the background value is still used for unassociated pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input vector dataset to be rasterized. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> An output image containing the rasterized vector dataset. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -im <string> A reference image from which to import output grid and projection reference system information.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szx <int32> Output size along x axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szy <int32> Output size along y axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -epsg <int32> EPSG code for the output projection reference system (EPSG 4326 for WGS84, 32631 for UTM31N...,useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -orx <float> Output upper-left corner x coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ory <float> Output upper-left corner y coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spx <float> Spacing (ground sampling distance) along x axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spy <float> Spacing (ground sampling distance) along y axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -background <float> Default value for pixels not belonging to any geometry. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -mode Choice of rasterization modes binary,attribute. Mandatory: True. Default Value: "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -binary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.binary.foreground <float> Value for pixels inside a geometry. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.attribute.field <string> Name of the attribute field to burn. Mandatory: True. Default Value: "DN"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                For now, support of input dataset with multiple layers having different projection reference system is limited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rasterImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spx: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spy: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Rasterization-manual.html b/python/plugins/processing/algs/otb/description/doc/Rasterization-manual.html new file mode 100644 index 00000000000..6de3a2fbaba --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/Rasterization-manual.html @@ -0,0 +1,6 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterize a vector dataset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows to reproject and rasterize a vector dataset. The grid of the rasterized output can be set by using a reference image, or by setting all parmeters (origin, size, spacing) by hand. In the latter case, at least the spacing (ground sampling distance) is needed (other parameters are computed automatically). The rasterized output can also be in a different projection reference system than the input dataset. + There are two rasterize mode available in the application. The first is the binary mode: it allows to render all pixels belonging to a geometry of the input dataset in the foreground color, while rendering the other in background color. The second one allows to render pixels belonging to a geometry woth respect to an attribute of this geometry. The field of the attribute to render can be set by the user. In the second mode, the background value is still used for unassociated pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input vector dataset to be rasterized. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> An output image containing the rasterized vector dataset. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -im <string> A reference image from which to import output grid and projection reference system information.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szx <int32> Output size along x axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szy <int32> Output size along y axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -epsg <int32> EPSG code for the output projection reference system (EPSG 4326 for WGS84, 32631 for UTM31N...,useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -orx <float> Output upper-left corner x coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ory <float> Output upper-left corner y coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spx <float> Spacing (ground sampling distance) along x axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spy <float> Spacing (ground sampling distance) along y axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -background <float> Default value for pixels not belonging to any geometry. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -mode Choice of rasterization modes binary,attribute. Mandatory: True. Default Value: "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -binary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.binary.foreground <float> Value for pixels inside a geometry. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.attribute.field <string> Name of the attribute field to burn. Mandatory: True. Default Value: "DN"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                For now, support of input dataset with multiple layers having different projection reference system is limited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rasterImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spx: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spy: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Rasterization.html b/python/plugins/processing/algs/otb/description/doc/Rasterization.html index e8850f56551..6de3a2fbaba 100644 --- a/python/plugins/processing/algs/otb/description/doc/Rasterization.html +++ b/python/plugins/processing/algs/otb/description/doc/Rasterization.html @@ -2,5 +2,5 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterize a vector dataset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows reprojecting and rasterizing a vector dataset. The grid of the rasterized output can be set by using a reference image, or by setting all parmeters (origin, size, spacing) by hand. In the latter case, at least the spacing (ground sampling distance) is needed (other parameters are computed automatically). The rasterized output can also be in a different projection reference system than the input dataset. - There are two rasterize mode available in the application. The first is the binary mode: it allows rendering all pixels belonging to a geometry of the input dataset in the foreground color, while rendering the other in background color. The second one allows rendering pixels belonging to a geometry woth respect to an attribute of this geometry. The field of the attribute to render can be set by the user. In the second mode, the background value is still used for unassociated pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input vector dataset to be rasterized. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> An output image containing the rasterized vector dataset. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -im <string> A reference image from which to import output grid and projection reference system information.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szx <int32> Output size along x axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szy <int32> Output size along y axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -epsg <int32> EPSG code for the output projection reference system (EPSG 4326 for WGS84, 32631 for UTM31N...,useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -orx <float> Output upper-left x coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ory <float> Output upper-left y coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spx <float> Spacing (ground sampling distance) along x axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spy <float> Spacing (ground sampling distance) along y axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -background <float> Default value for pixels not belonging to any geometry. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -mode Choice of rasterization modes binary,attribute. Mandatory: True. Default Value: "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -binary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.binary.foreground <float> Value for pixels inside a geometry. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.attribute.field <string> Name of the attribute field to burn. Mandatory: True. Default Value: "DN"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                For now, support of input dataset with multiple layers having different projection reference system is limited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rasterImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spx: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spy: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterization

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Rasterize a vector dataset.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application allows to reproject and rasterize a vector dataset. The grid of the rasterized output can be set by using a reference image, or by setting all parmeters (origin, size, spacing) by hand. In the latter case, at least the spacing (ground sampling distance) is needed (other parameters are computed automatically). The rasterized output can also be in a different projection reference system than the input dataset. + There are two rasterize mode available in the application. The first is the binary mode: it allows to render all pixels belonging to a geometry of the input dataset in the foreground color, while rendering the other in background color. The second one allows to render pixels belonging to a geometry woth respect to an attribute of this geometry. The field of the attribute to render can be set by the user. In the second mode, the background value is still used for unassociated pixels.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input vector dataset to be rasterized. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> An output image containing the rasterized vector dataset. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -im <string> A reference image from which to import output grid and projection reference system information.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szx <int32> Output size along x axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -szy <int32> Output size along y axis (useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -epsg <int32> EPSG code for the output projection reference system (EPSG 4326 for WGS84, 32631 for UTM31N...,useless if support image is given). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -orx <float> Output upper-left corner x coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ory <float> Output upper-left corner y coordinate (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spx <float> Spacing (ground sampling distance) along x axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spy <float> Spacing (ground sampling distance) along y axis (useless if support image is given). Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -background <float> Default value for pixels not belonging to any geometry. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -mode Choice of rasterization modes binary,attribute. Mandatory: True. Default Value: "binary"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -binary
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.binary.foreground <float> Value for pixels inside a geometry. Mandatory: True. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -attribute
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -mode.attribute.field <string> Name of the attribute field to burn. Mandatory: True. Default Value: "DN"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                For now, support of input dataset with multiple layers having different projection reference system is limited.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rasterImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spx: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • spy: 1.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/ReadImageInfo.html b/python/plugins/processing/algs/otb/description/doc/ReadImageInfo.html index 60791e89636..1084db71622 100644 --- a/python/plugins/processing/algs/otb/description/doc/ReadImageInfo.html +++ b/python/plugins/processing/algs/otb/description/doc/ReadImageInfo.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadImageInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get information about the image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Utilities,Image Manipulation,Image MetaData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Display information about the input image like: image size, origin, spacing, metadata, projections...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> Input image to analyse. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -keywordlist <boolean> Output the OSSIM keyword list. It contains metadata information (sensor model, geometry ). Information are stored in keyword list (pairs of key/value). Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outkwl <string> This option allows extracting the OSSIM keywordlist of the image into a geom file.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -indexx <int32> X start index. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -indexy <int32> Y start index. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sizex <int32> X size (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sizey <int32> Y size (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spacingx <float> Pixel size along X (in physical units). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spacingy <float> Pixel size along Y (in physical units). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -originx <float> Origin along X. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -originy <float> Origin along Y. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -estimatedgroundspacingx <float> Estimated ground spacing along X (in meters).. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -estimatedgroundspacingy <float> Estimated ground spacing along Y (in meters).. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -numberbands <int32> Number of bands. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sensor <string> Sensor identifier. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -id <string> Image identifier. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -time <string> Acquisition time.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ullat <float> Lattitude of the upper left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ullon <float> Longitude of the upper left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -urlat <float> Lattitude of the upper right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -urlon <float> Longitude of the upper right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lrlat <float> Lattitude of the lower right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lrlon <float> Longitude of the lower right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lllat <float> Lattitude of the lower left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lllon <float> Longitude of the lower left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -town <string> Main town near center of image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -country <string> Country of the image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rgb <string> This group of parameters allows accessing the default rgb composition.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -projectionref <string> Projection Coordinate System. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -keyword <string> Image keyword list. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -gcp <string> This group of parameters allows accessing the GCPs information.. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                ReadImageInfo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Get information about the image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Utilities,Image Manipulation,Image MetaData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Display information about the input image like: image size, origin, spacing, metadata, projections...

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> Input image to analyse. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -keywordlist <boolean> Output the OSSIM keyword list. It contains metadata information (sensor model, geometry ). Informations are stored in keyword list (pairs of key/value). Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outkwl <string> This option allows to extract the OSSIM keywordlist of the image into a geom file.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -indexx <int32> X start index. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -indexy <int32> Y start index. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sizex <int32> X size (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sizey <int32> Y size (in pixels). Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spacingx <float> Pixel size along X (in physical units). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -spacingy <float> Pixel size along Y (in physical units). Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -originx <float> Origin along X. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -originy <float> Origin along Y. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -estimatedgroundspacingx <float> Estimated ground spacing along X (in meters).. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -estimatedgroundspacingy <float> Estimated ground spacing along Y (in meters).. Mandatory: True. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -numberbands <int32> Number of bands. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sensor <string> Sensor identifier. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -id <string> Image identifier. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -time <string> Acquisition time.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ullat <float> Lattitude of the upper left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ullon <float> Longitude of the upper left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -urlat <float> Lattitude of the upper right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -urlon <float> Longitude of the upper right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lrlat <float> Lattitude of the lower right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lrlon <float> Longitude of the lower right corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lllat <float> Lattitude of the lower left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -lllon <float> Longitude of the lower left corner.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -town <string> Main town near center of image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -country <string> Country of the image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rgb <string> This group of parameters allows to access to the default rgb composition.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -projectionref <string> Projection Coordinate System. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -keyword <string> Image keyword list. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -gcp <string> This group of parameters allows to access to the GCPs informations.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RefineSensorModel.html b/python/plugins/processing/algs/otb/description/doc/RefineSensorModel.html index 62343418b33..6bcfc928131 100644 --- a/python/plugins/processing/algs/otb/description/doc/RefineSensorModel.html +++ b/python/plugins/processing/algs/otb/description/doc/RefineSensorModel.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RefineSensorModel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Perform least-square fit of a sensor model to a set of tie points

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application reads a geom file containing a sensor model and a text file containing a list of ground control point, and performs a least-square fit of the sensor model adjustable parameters to these tie points. It produces an updated geom file as output, as well as an optional ground control points based statistics file and a vector file containing residues. The output geom file can then be used to ortho-rectify the data more accurately. Plaease note that for a proper use of the application, elevation must be correctly set (including DEM and geoid file). The map parameters allows choosing a map projection in which the accuracy will be estimated in meters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ingeom <string> Geom file containing the sensor model to refine. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outgeom <string> Geom file containing the refined sensor model. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inpoints <string> Input file containing tie points. Points are stored in following format: row col lon lat. Line beginning with # are ignored.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outstat <string> Output file containing the following info: ref_lon ref_lat elevation predicted_lon predicted_lat x_error_ref(meters) y_error_ref(meters) global_error_ref(meters) x_error(meters) y_error(meters) overall_error(meters). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outvector <string> File containing segments representing residues. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OrthoRectification,HomologousPointsExtraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • ingeom: input.geom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • outgeom: output.geom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • inpoints: points.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map: epsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • map.epsg.code: 32631

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      RefineSensorModel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Perform least-square fit of a sensor model to a set of tie points

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This application reads a geom file containing a sensor model and a text file containing a list of ground control point, and performs a least-square fit of the sensor model adjustable parameters to these tie points. It produces an updated geom file as output, as well as an optional ground control points based statistics file and a vector file containing residues. The output geom file can then be used to ortho-rectify the data more accurately. Plaease note that for a proper use of the application, elevation must be correctly set (including DEM and geoid file). The map parameters allows to choose a map projection in which the accuracy will be estimated in meters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -ingeom <string> Geom file containing the sensor model to refine. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outgeom <string> Geom file containing the refined sensor model. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inpoints <string> Input file containing tie points. Points are stored in following format: row col lon lat. Line beginning with # are ignored.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outstat <string> Output file containing the following info: ref_lon ref_lat elevation predicted_lon predicted_lat x_error_ref(meters) y_error_ref(meters) global_error_ref(meters) x_error(meters) y_error(meters) overall_error(meters). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outvector <string> File containing segments representing residues. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "utm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OrthoRectification,HomologousPointsExtraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ingeom: input.geom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outgeom: output.geom

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inpoints: points.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map: epsg

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • map.epsg.code: 32631

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Rescale.html b/python/plugins/processing/algs/otb/description/doc/Rescale.html index 54e0c26923a..bb606af15ef 100644 --- a/python/plugins/processing/algs/otb/description/doc/Rescale.html +++ b/python/plugins/processing/algs/otb/description/doc/Rescale.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rescale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rescale the image between two given values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application scales the given image pixel intensity between two given values. By default min (resp. max) value is set to 0 (resp. 255).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The image to scale.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> The rescaled image filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outmin <float> Minimum value of the output image.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outmax <float> Maximum value of the output image.. Mandatory: False. Default Value: "255"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: rescaledImage.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outmin: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outmax: 255

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rescale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Rescale the image between two given values.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application scales the given image pixel intensity between two given values. By default min (resp. max) value is set to 0 (resp. 255).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The image to scale.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> The rescaled image filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outmin <float> Minimum value of the output image.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outmax <float> Maximum value of the output image.. Mandatory: False. Default Value: "255"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: rescaledImage.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outmin: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outmax: 255

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-id.html b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-id.html index 321e249c646..5d99b119c17 100644 --- a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-id.html +++ b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-id.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -transform <string> This group of parameters allows setting the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -transform <string> This group of parameters allows to set the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-rotation.html b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-rotation.html index 321e249c646..5d99b119c17 100644 --- a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-rotation.html +++ b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-rotation.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -transform <string> This group of parameters allows setting the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -transform <string> This group of parameters allows to set the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -ram <int32> This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-translation.html b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-translation.html index 321e249c646..5d99b119c17 100644 --- a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-translation.html +++ b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample-translation.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -transform <string> This group of parameters allows setting the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -transform <string> This group of parameters allows to set the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -ram <int32> This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample.html b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample.html index 321e249c646..5d99b119c17 100644 --- a/python/plugins/processing/algs/otb/description/doc/RigidTransformResample.html +++ b/python/plugins/processing/algs/otb/description/doc/RigidTransformResample.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -transform <string> This group of parameters allows setting the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -ram <int32> This allows setting the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        RigidTransformResample

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Resample an image with a rigid transform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Conversion,Geometry

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application performs a parametric transform on the input image. Scaling, translation and rotation with scaling factor are handled. Parameters of the transform is expressed in physical units, thus particular attention must be paid on pixel size (value, and sign). Moreover transform is expressed from input space to output space (on the contrary ITK Transforms are expressed form output space to input space).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -in <string> The input image to translate.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> The transformed output image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -transform <string> This group of parameters allows to set the transformation to apply.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -ram <int32> This allows to set the maximum amount of RAM available for processing. As the writing task is time consuming, it is better to write large pieces of data, which can be achieved by increasing this parameter (pay attention to your system capabilities). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. nn,linear,bco. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -linear
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Translation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: qb_toulouse_sub.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: rigitTransformImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type: rotation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.angle: 20

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.scalex: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • transform.type.rotation.scaley: 2.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/SFSTextureExtraction.html b/python/plugins/processing/algs/otb/description/doc/SFSTextureExtraction.html index ad59a52ad38..25dd0c7bd34 100644 --- a/python/plugins/processing/algs/otb/description/doc/SFSTextureExtraction.html +++ b/python/plugins/processing/algs/otb/description/doc/SFSTextureExtraction.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SFSTextureExtraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Computes Structural Feature Set textures on every pixel of the input image selected channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Textures,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application computes SFS textures on a mono band image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -parameters <string> This group of parameters allows defining SFS texture parameters. The available texture features are SFS'Length, SFS'Width, SFS'PSI, SFS'W-Mean, SFS'Ratio and SFS'SD. They are provided in this exact order in the output image.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output image containing the SFS texture features.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbSFSTexturesImageFilter class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • channel: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • parameters.spethre: 50.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • parameters.spathre: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SFSTextures.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SFSTextureExtraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Computes Structural Feature Set textures on every pixel of the input image selected channel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Textures,Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application computes SFS textures on a mono band image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to compute the features on.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -channel <int32> The selected channel index. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -parameters <string> This group of parameters allows to define SFS texture parameters. The available texture features are SFS'Length, SFS'Width, SFS'PSI, SFS'W-Mean, SFS'Ratio and SFS'SD. They are provided in this exact order in the output image.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output image containing the SFS texture features.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbSFSTexturesImageFilter class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • channel: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • parameters.spethre: 50.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • parameters.spathre: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SFSTextures.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/SOMClassification.html b/python/plugins/processing/algs/otb/description/doc/SOMClassification.html index e5a6742423c..a6fc8a522df 100644 --- a/python/plugins/processing/algs/otb/description/doc/SOMClassification.html +++ b/python/plugins/processing/algs/otb/description/doc/SOMClassification.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SOMClassification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SOM image classification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation,Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Unsupervised Self Organizing Map image classification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output classified image (each pixel contains the index of its corresponding vector in the SOM).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -vm <string> Validity mask (only pixels corresponding to a mask value greater than 0 will be used for learning). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -tp <float> Probability for a sample to be selected in the training set. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ts <int32> Maximum training set size (in pixels). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -sl <int32> Number of lines in each streaming block (used during data sampling). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -som <string> Output image containing the Self-Organizing Map. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -sx <int32> X size of the SOM map. Mandatory: False. Default Value: "32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -sy <int32> Y size of the SOM map. Mandatory: False. Default Value: "32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -nx <int32> X size of the initial neighborhood in the SOM map. Mandatory: False. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ny <int32> Y size of the initial neighborhood in the SOM map. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ni <int32> Number of iterations for SOM learning. Mandatory: False. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -bi <float> Initial learning coefficient. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -bf <float> Final learning coefficient. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -iv <float> Maximum initial neuron weight. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SOMClassification.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • tp: 1.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ts: 16384

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sl: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sx: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sy: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • nx: 10

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ny: 10

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ni: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bi: 1.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bf: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • iv: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SOMClassification

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SOM image classification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation,Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Unsupervised Self Organizing Map image classification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to classify.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output classified image (each pixel contains the index of its corresponding vector in the SOM).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -vm <string> Validity mask (only pixels corresponding to a mask value greater than 0 will be used for learning). Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -tp <float> Probability for a sample to be selected in the training set. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ts <int32> Maximum training set size (in pixels). Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -som <string> Output image containing the Self-Organizing Map. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -sx <int32> X size of the SOM map. Mandatory: False. Default Value: "32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -sy <int32> Y size of the SOM map. Mandatory: False. Default Value: "32"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -nx <int32> X size of the initial neighborhood in the SOM map. Mandatory: False. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ny <int32> Y size of the initial neighborhood in the SOM map. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ni <int32> Number of iterations for SOM learning. Mandatory: False. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -bi <float> Initial learning coefficient. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -bf <float> Final learning coefficient. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -iv <float> Maximum initial neuron weight. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SOMClassification.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • tp: 1.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ts: 16384

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sx: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • sy: 32

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • nx: 10

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ny: 10

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • ni: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bi: 1.0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • bf: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • iv: 0

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/SarRadiometricCalibration.html b/python/plugins/processing/algs/otb/description/doc/SarRadiometricCalibration.html index 718529a9d72..52be7031060 100644 --- a/python/plugins/processing/algs/otb/description/doc/SarRadiometricCalibration.html +++ b/python/plugins/processing/algs/otb/description/doc/SarRadiometricCalibration.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SarRadiometricCalibration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Perform SAR calibration on input complex images

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Calibration,SAR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs SAR calibration on input complex images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input complex image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output calibrated complex image. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -noise <boolean> Flag to disable noise. Mandatory: False. Default Value: "True"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: RSAT_imagery_HH.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SarRadiometricCalibration.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SarRadiometricCalibration

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Perform SAR calibration on input complex images

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Calibration,SAR

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs SAR calibration on input complex images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input complex image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output calibrated complex image. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -noise <boolean> Flag to disable noise. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: RSAT_imagery_HH.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SarRadiometricCalibration.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation-cc.html b/python/plugins/processing/algs/otb/description/doc/Segmentation-cc.html index 763cd6810ef..9931c12bb31 100644 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation-cc.html +++ b/python/plugins/processing/algs/otb/description/doc/Segmentation-cc.html @@ -2,8 +2,10 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to perform various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. +In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colours. Please note that this mode loads the whole input image into memory, and as such can not handle large images. -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows to simplify the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows to application to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. +MeanShift filter results depends on the number of threads used. +Watershed and multiscale geodesic morphology segmentation will be performed on the amplitude of the input image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation-edison.html b/python/plugins/processing/algs/otb/description/doc/Segmentation-edison.html deleted file mode 100644 index 763cd6810ef..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation-edison.html +++ /dev/null @@ -1,9 +0,0 @@ - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. - -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. - -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation-meanshift.html b/python/plugins/processing/algs/otb/description/doc/Segmentation-meanshift.html index 763cd6810ef..9931c12bb31 100644 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation-meanshift.html +++ b/python/plugins/processing/algs/otb/description/doc/Segmentation-meanshift.html @@ -2,8 +2,10 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to perform various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. +In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colours. Please note that this mode loads the whole input image into memory, and as such can not handle large images. -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows to simplify the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows to application to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. +MeanShift filter results depends on the number of threads used. +Watershed and multiscale geodesic morphology segmentation will be performed on the amplitude of the input image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation-mprofiles.html b/python/plugins/processing/algs/otb/description/doc/Segmentation-mprofiles.html index 763cd6810ef..9931c12bb31 100644 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation-mprofiles.html +++ b/python/plugins/processing/algs/otb/description/doc/Segmentation-mprofiles.html @@ -2,8 +2,10 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to perform various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. +In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colours. Please note that this mode loads the whole input image into memory, and as such can not handle large images. -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows to simplify the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows to application to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. +MeanShift filter results depends on the number of threads used. +Watershed and multiscale geodesic morphology segmentation will be performed on the amplitude of the input image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation-watershed.html b/python/plugins/processing/algs/otb/description/doc/Segmentation-watershed.html index 763cd6810ef..9931c12bb31 100644 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation-watershed.html +++ b/python/plugins/processing/algs/otb/description/doc/Segmentation-watershed.html @@ -2,8 +2,10 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to perform various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. +In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colours. Please note that this mode loads the whole input image into memory, and as such can not handle large images. -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows to simplify the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows to application to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. +MeanShift filter results depends on the number of threads used. +Watershed and multiscale geodesic morphology segmentation will be performed on the amplitude of the input image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Segmentation.html b/python/plugins/processing/algs/otb/description/doc/Segmentation.html index 763cd6810ef..9931c12bb31 100644 --- a/python/plugins/processing/algs/otb/description/doc/Segmentation.html +++ b/python/plugins/processing/algs/otb/description/doc/Segmentation.html @@ -2,8 +2,10 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input datasets are supported.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows to perform various segmentation algorithms on a multispectral image.Available segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being multi-threaded), simple pixel based connected components according to a user-defined criterion, and watershed from the gradient of the intensity (norm of spectral bands vector). The application has two different modes that affects the nature of its output. -In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colors. Please note that this mode loads the whole input image into memory, and as such can not handle large images. +In raster mode, the output of the application is a classical image of unique labels identifying the segmented regions. The labeled output can be passed to the ColorMapping application to render regions with contrasted colours. Please note that this mode loads the whole input image into memory, and as such can not handle large images. -To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows applying to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,edison,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -edison
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.spatialr <int32> Spatial radius defining neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multi-spectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.minsize <int32> Minimum size of a region in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.edison.scale <float> Scaling of the image before processing. This is useful for images with narrow decimal ranges (like [0,1] for instance). . Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows setting the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows reducing the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. MeanShift filter results depends on threads number.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            +To segment large data, one can use the vector mode. In this case, the output of the application is a vector file or database. The input image is split into tiles (whose size can be set using the tilesize parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written into the output file or database. This piece-wise behavior ensure that memory will never get overloaded, and that images of any size can be processed. There are few more options in the vector mode. The simplify option allows to simplify the geometry (i.e. remove nodes in polygons) according to a user-defined tolerance. The stitch option allows to application to try to stitch together polygons corresponding to segmented region that may have been split by the tiling scheme.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> The input image to segment. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -filter Choice of segmentation algorithm (mean-shift by default) meanshift,cc,watershed,mprofiles. Mandatory: True. Default Value: "meanshift"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -meanshift
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.spatialr <int32> Spatial radius of the neighborhood.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.ranger <float> Range radius defining the radius (expressed in radiometry unit) in the multispectral space.. Mandatory: True. Default Value: "15"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.thres <float> Algorithm iterative scheme will stop if mean-shift vector is below this threshold or if iteration number reached maximum number of iterations.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.maxiter <int32> Algorithm iterative scheme will stop if convergence hasn't been reached after the maximum number of iterations.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.meanshift.minsize <int32> Minimum size of a region (in pixel unit) in segmentation. Smaller clusters will be merged to the neighboring cluster with the closest radiometry. If set to 0 no pruning is done.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -cc
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.cc.expr <string> User defined connection condition, written as a mathematical expression. Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : distance < 10 ). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -watershed
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.threshold <float> Depth threshold Units in percentage of the maximum depth in the image.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.watershed.level <float> flood level for generating the merge tree from the initial segmentation (between 0 and 1). Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mprofiles
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.size <int32> Size of the profiles. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.start <int32> Initial radius of the structuring element (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.step <int32> Radius step along the profile (in pixels). Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -filter.mprofiles.sigma <float> Profiles values under the threshold will be ignored.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              [choice] -mode Choice of processing mode, either raster or large-scale. vector,raster. Mandatory: True. Default Value: "vector"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -vector
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.out <string> The output vector file or database (name can be anything understood by OGR). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.outmode <string> This allows to set the writing behaviour for the output vector file. Please note that the actual behaviour depends on the file format.. Mandatory: True. Default Value: "ulco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.inmask <string> Only pixels whose mask value is strictly positive will be segmented.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.neighbor <boolean> Activate 8-Neighborhood connectivity (default is 4).. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.stitch <boolean> Scan polygons on each side of tiles and stitch polygons which connect by more than one pixel.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.minsize <int32> Objects whose size is below the minimum object size (area in pixels) will be ignored during vectorization.. Mandatory: False. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.simplify <float> Simplify polygons according to a given tolerance (in pixel). This option allows to reduce the size of the output file or database.. Mandatory: False. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.layername <string> Name of the layer in the vector file or database (default is Layer).. Mandatory: True. Default Value: "layer"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.fieldname <string> Name of the field holding the geometry index in the output vector file or database.. Mandatory: True. Default Value: "DN"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.tilesize <int32> User defined tiles size for tile-based segmentation. Optimal tile size is selected according to available RAM if null.. Mandatory: True. Default Value: "1024"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.startlabel <int32> Starting value of the geometry index field. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.vector.ogroptions <string> A list of layer creation options in the form KEY=VALUE that will be passed directly to OGR without any validity checking. Options may depend on the file format, and can be found in OGR documentation.. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -raster
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -mode.raster.out <string> The output labeled image.. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode might become slow with very large input images. +MeanShift filter results depends on the number of threads used. +Watershed and multiscale geodesic morphology segmentation will be performed on the amplitude of the input image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            MeanShiftSegmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with vector mode and watershed segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.vector.out: SegmentationVector.sqlite

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Example of use with raster mode and mean-shift segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode: raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • mode.raster.out: SegmentationRaster.tif uint16

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • filter: meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentation.html b/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentation.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentation.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Detailed description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameter key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Parameter type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameter description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Input Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter edison

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter cc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Connected components

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scale factor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Condition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Flood Level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Processing mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Output File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mask Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum object size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Layer name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tiles size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Output image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Output labeled image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Examples
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - diff --git a/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentationVector.html b/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentationVector.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/SimpleConnectedComponentsSegmentationVector.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Detailed description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameter key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Parameter type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameter description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Input Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter edison

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter cc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Connected components

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Scale factor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Condition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Flood Level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Processing mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Output File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Mask Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Minimum object size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Layer name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tiles size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		String list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            		Output image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Output labeled image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Examples
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See also
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            - diff --git a/python/plugins/processing/algs/otb/description/doc/Smoothing-anidif.html b/python/plugins/processing/algs/otb/description/doc/Smoothing-anidif.html index 56a08faab8b..c8bcf1ce16d 100644 --- a/python/plugins/processing/algs/otb/description/doc/Smoothing-anidif.html +++ b/python/plugins/processing/algs/otb/description/doc/Smoothing-anidif.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Number of iterations. Mandatory: True. Default Value: "10"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Controls the sensitivity of the conductance term. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.conductance <float> . Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.conductance: 1.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Smoothing-gaussian.html b/python/plugins/processing/algs/otb/description/doc/Smoothing-gaussian.html index 56a08faab8b..c8bcf1ce16d 100644 --- a/python/plugins/processing/algs/otb/description/doc/Smoothing-gaussian.html +++ b/python/plugins/processing/algs/otb/description/doc/Smoothing-gaussian.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Number of iterations. Mandatory: True. Default Value: "10"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Controls the sensitivity of the conductance term. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.conductance <float> . Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.conductance: 1.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Smoothing-mean.html b/python/plugins/processing/algs/otb/description/doc/Smoothing-mean.html index 56a08faab8b..c8bcf1ce16d 100644 --- a/python/plugins/processing/algs/otb/description/doc/Smoothing-mean.html +++ b/python/plugins/processing/algs/otb/description/doc/Smoothing-mean.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Number of iterations. Mandatory: True. Default Value: "10"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Controls the sensitivity of the conductance term. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.conductance <float> . Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.conductance: 1.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Smoothing.html b/python/plugins/processing/algs/otb/description/doc/Smoothing.html index 56a08faab8b..c8bcf1ce16d 100644 --- a/python/plugins/processing/algs/otb/description/doc/Smoothing.html +++ b/python/plugins/processing/algs/otb/description/doc/Smoothing.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Number of iterations. Mandatory: True. Default Value: "10"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Smoothing

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Apply a smoothing filter to an image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Filtering

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application applies smoothing filter to an image. Either gaussian, mean, or anisotropic diffusion are available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input image to smooth.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output smoothed image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -type Smoothing kernel to apply mean,gaussian,anidif. Mandatory: True. Default Value: "anidif"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -mean
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.mean.radius <int32> Mean radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -gaussian
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.gaussian.radius <float> Gaussian radius (in pixels). Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -anidif
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.timestep <float> Diffusion equation time step. Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.nbiter <int32> Controls the sensitivity of the conductance term. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -type.anidif.conductance <float> . Mandatory: True. Default Value: "1"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using a mean filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_mean.png uchar

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: mean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • Image smoothing using an anisotropic diffusion filter.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • in: Romania_Extract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • out: smoothedImage_ani.png float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type: anidif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.timestep: 0.1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.nbiter: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • type.anidif.conductance: 1.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/SplitImage.html b/python/plugins/processing/algs/otb/description/doc/SplitImage.html index c5c0238f2d6..b589865061d 100644 --- a/python/plugins/processing/algs/otb/description/doc/SplitImage.html +++ b/python/plugins/processing/algs/otb/description/doc/SplitImage.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SplitImage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Split a N multiband image into N images

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application splits a N-bands image into N mono-band images. The output images filename will be generated from the output parameter. Thus if the input image has 2 channels, and the user has set an output outimage.tif, the generated images will be outimage_0.tif and outimage_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input multiband image filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output filename that will be used to get the prefix and the extension of the output images to write. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: VegetationIndex.hd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: splittedImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            SplitImage

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Split a N multiband image into N images

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application splits a N-bands image into N mono-band images. The output images filename will be generated from the output parameter. Thus if the input image has 2 channels, and the user has set an output outimage.tif, the generated images will be outimage_0.tif and outimage_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -in <string> Input multiband image filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output filename that will be used to get the prefix and the extension of the output images to write. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • in: VegetationIndex.hd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: splittedImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/StereoFramework.html b/python/plugins/processing/algs/otb/description/doc/StereoFramework.html index c193d01aacc..687acadd8f1 100644 --- a/python/plugins/processing/algs/otb/description/doc/StereoFramework.html +++ b/python/plugins/processing/algs/otb/description/doc/StereoFramework.html @@ -4,7 +4,7 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; t

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            StereoFramework

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Compute the ground elevation based on one or multiple stereo pair(s)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Stereo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Compute the ground elevation with a stereo block matching algorithm between one or mulitple stereo pair in sensor geometry. The output is projected in desired geographic or cartographic map projection (UTM by default). The pipeline is made of the following steps: for each sensor pair : - - compute the epipolar deformation grids from the stereo pair (direct and inverse) + - compute the epipolar displacement grids from the stereo pair (direct and inverse) - resample the stereo pair into epipolar geometry using BCO interpolation - create masks for each epipolar image : remove black borders and resample input masks - compute horizontal disparities with a block matching algorithm @@ -13,4 +13,4 @@ for each sensor pair : - filter disparities based on the correlation score and exploration bounds - translate disparities in sensor geometry convert disparity to 3D Map. -Then fuse all 3D maps to produce DSM.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -input <string> This group of parameters allows parametrizing input data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -output <string> This group of parameters allows choosing the DSM resolution, nodata value, and projection parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -stereorect <string> This group of parameters allow choosing direct and inverse grid subsampling. These parameters are very useful to tune time and memory consumption.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -bm <string> This group of parameters allow to tune the block-matching behavior. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -postproc <string> This group of parameters allow use optional filters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -mask <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "wgs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows defining the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • input.il: sensor_stereo_left.tif sensor_stereo_right.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • elev.default: 200

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • stereorect.fwdgridstep: 8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • stereorect.invgridssrate: 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • postproc.med: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • output.res: 2.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • output.out: dem.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  +Then fuse all 3D maps to produce DSM.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -input <string> This group of parameters allows to parametrize input data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -output <string> This group of parameters allows to choose the DSM resolution, nodata value, and projection parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -stereorect <string> This group of parameters allows to choose direct and inverse grid subsampling. These parameters are very useful to tune time and memory consumption.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -bm <string> This group of parameters allow to tune the block-matching behavior. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -postproc <string> This group of parameters allow use optional filters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -mask <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -map Parameters of the output map projection to be used. utm,lambert2,lambert93,wgs,epsg. Mandatory: True. Default Value: "wgs"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -utm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.utm.zone <int32> The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere). Mandatory: True. Default Value: "31"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -map.utm.northhem <boolean> The transverse mercator projections are defined by their zone number as well as the hemisphere. Activate this parameter if your image is in the northern hemisphere.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -lambert2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -lambert93
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -wgs
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -epsg
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -map.epsg.code <int32> See www.spatialreference.org to find which EPSG code is associated to your projection. Mandatory: True. Default Value: "4326"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • input.il: sensor_stereo_left.tif sensor_stereo_right.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • elev.default: 200

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stereorect.fwdgridstep: 8

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • stereorect.invgridssrate: 4

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • postproc.med: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • output.res: 2.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • output.out: dem.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/StereoRectificationGridGenerator.html b/python/plugins/processing/algs/otb/description/doc/StereoRectificationGridGenerator.html index c5894e09bea..72a7d28fb59 100644 --- a/python/plugins/processing/algs/otb/description/doc/StereoRectificationGridGenerator.html +++ b/python/plugins/processing/algs/otb/description/doc/StereoRectificationGridGenerator.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StereoRectificationGridGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generates two deformation fields to stereo-rectify (i.e. resample in epipolar geometry) a pair of stereo images up to the sensor model precision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stereo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application generates a pair of deformation grid to stereo-rectify a pair of stereo images according to sensor modelling and a mean elevation hypothesis. The deformation grids can be passed to the StereoRectificationGridGenerator application for actual resampling in epipolar geometry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows setting the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -epi <string> Parameters of the epipolar geometry and output grids. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inverse <string> This group of parameter allows generating the inverse fields as well. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generation of the deformation grid is not streamable, pay attention to this fact when setting the grid step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        otbGridBasedImageResampling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.inleft: wv2_xs_left.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.inright: wv2_xs_left.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.outleft: wv2_xs_left_epi_field.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.outright: wv2_xs_right_epi_field.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • epi.elevation.default: 400

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        StereoRectificationGridGenerator

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generates two deformation fields to stereo-rectify (i.e. resample in epipolar geometry) a pair of stereo images up to the sensor model precision

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stereo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application generates a pair of deformation grid to stereo-rectify a pair of stereo images according to sensor modelling and a mean elevation hypothesis. The deformation grids can be passed to the StereoRectificationGridGenerator application for actual resampling in epipolar geometry.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set the input and output images.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -epi <string> Parameters of the epipolar geometry and output grids. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inverse <string> This group of parameter allows to generate the inverse fields as well. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Generation of the deformation grid is not streamable, pay attention to this fact when setting the grid step.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        otbGridBasedImageResampling

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.inleft: wv2_xs_left.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.inright: wv2_xs_left.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.outleft: wv2_xs_left_epi_field.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • io.outright: wv2_xs_right_epi_field.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • epi.elevation.default: 400

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/StereoSensorModelToElevationMap.html b/python/plugins/processing/algs/otb/description/doc/StereoSensorModelToElevationMap.html deleted file mode 100644 index 2e4590caecb..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/StereoSensorModelToElevationMap.html +++ /dev/null @@ -1 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Stereo sensor model to elevation map Application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Convert a stereo sensor model to elevation map.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Image Manipulation, Stereo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Produce an elevation map from a pair of stereo images along-track by implicit exploration of their epipolar lines.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Reference (-ref): The reference image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Secondary (-sec): The secondary image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Output Image (-out): The output image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Available RAM (-ram): Set the maximum of available memory for the pipeline execution in mega bytes (optional, 256 by default)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Radius (-r): Radius (in pixels) of the metric computation window (default is 3).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Correlation Threshold (-ct): Threshold bellow which correlation is considered invalid (default is 0.7).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] Variance Threshold (-vt): Threshold on the master patch variance bellow which no height exploration is performed (default is 4).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] MinHeightOffset (-minh): Minimum height offset with respect to local initial height for height exploration (default is -20 meters).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] MaxHeightOffset (-maxh): Maximum height offset with respect to local initial height for height exploration (default is 20 meters).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] HeightStep (-step): Step of height exploration (default is 1 meter).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] AverageElevation (-ae): If no DEM is used, provide the initial height value (default is 0 meters)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] DEMDirectory (-dem): Use DEM tiles to derive initial height values (AverageElevation option is ignored in this case)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] GeoidFile (-geoid): Use a geoid file along with the DEM tiles

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] ReferenceGaussianSmoothing (-rgs): (optional) Perform a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels). Default is no smoothing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] SecondaryGaussianSmoothing (-sgs): (optional) Perform a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels). Default is no smoothing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] SubtractInitialHeight (-s): If activated, the elevation map will contain only the estimated height offset from the initial height (either average elevation or DEM)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        See also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Reference: sensor_stereo_left.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Secondary: sensor_stereo_right.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • Output Image: StereoSensorModelToElevationMap.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • DEMDirectory: DEM

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • GeoidFile: egm96.grd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • otbcli_StereoSensorModelToElevationMap -ref sensor_stereo_left.tif -sec sensor_stereo_right.tif -out StereoSensorModelToElevationMap.tif -dem DEM -geoid egm96.grd

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/Superimpose.html b/python/plugins/processing/algs/otb/description/doc/Superimpose.html index 9bec3156bb3..493ebc473fe 100644 --- a/python/plugins/processing/algs/otb/description/doc/Superimpose.html +++ b/python/plugins/processing/algs/otb/description/doc/Superimpose.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Superimpose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Using available image metadata, project one image onto another one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Geometry,Superimposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        This application performs the projection of an image into the geometry of another one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inr <string> The input reference image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inm <string> The image to reproject into the geometry of the reference input.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -lms <float> Generate a coarser deformation field with the given spacing. Mandatory: False. Default Value: "4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -out <string> Output reprojected image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -interpolator This group of parameters allows defining how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -interpolator.bco.radius <int32> This parameter allows controlling the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inr: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inm: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • out: SuperimposedXS_to_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Superimpose

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Using available image metadata, project one image onto another one

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Geometry,Superimposition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs the projection of an image into the geometry of another one.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inr <string> The input reference image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inm <string> The image to reproject into the geometry of the reference input.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -lms <float> Generate a coarser deformation field with the given spacing. Mandatory: False. Default Value: "4"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -out <string> Output reprojected image.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -ram <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] -mode Superimposition mode default,phr. Mandatory: True. Default Value: "default"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -default
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev.default <float> 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.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [group] -phr
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                [choice] -interpolator This group of parameters allows to define how the input image will be interpolated during resampling. bco,nn,linear. Mandatory: True. Default Value: "bco"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -bco
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -interpolator.bco.radius <int32> This parameter allows to control the size of the bicubic interpolation filter. If the target pixel size is higher than the input pixel size, increasing this parameter will reduce aliasing artefacts.. Mandatory: True. Default Value: "2"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] -nn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • inr: QB_Toulouse_Ortho_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • inm: QB_Toulouse_Ortho_XS.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • out: SuperimposedXS_to_PAN.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TestApplication.html b/python/plugins/processing/algs/otb/description/doc/TestApplication.html index c7475094321..aac6ba570cd 100644 --- a/python/plugins/processing/algs/otb/description/doc/TestApplication.html +++ b/python/plugins/processing/algs/otb/description/doc/TestApplication.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TestApplication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application helps developers to test parameters types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Test

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  The purpose of this application is to test parameters types.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -boolean <boolean> . Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -int <int32> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -float <float> . Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -string <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -filename <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outfilename <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -directory <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -ingroup <string> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -outgroup <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -il <string> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -cin <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -cout <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -choice choice1,choice2,choice3. Mandatory: True. Default Value: "choice1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -choice1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -choice.choice1.floatchoice1 <float> . Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -choice2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -choice3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -choice.choice3.floatchoice3 <float> . Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      [choice] -cl choice1,choice2. Mandatory: False. Default Value: "choice1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -choice1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -choice.choice1.floatchoice1 <float> . Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] -choice2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • boolean: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • filename: myFilename.foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      TestApplication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      This application helps developers to test parameters types

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Test

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      The purpose of this application is to test parameters types.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -boolean <boolean> . Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -int <int32> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -float <float> . Mandatory: False. Default Value: "0.0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -string <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -filename <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outfilename <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -directory <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -ingroup <string> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outgroup <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -il <string> . Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -cin <string> . Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -cout <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [choice] -choice choice1,choice2,choice3. Mandatory: True. Default Value: "choice1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -choice1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -choice.choice1.floatchoice1 <float> . Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [group] -choice2
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -choice3
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -choice.choice3.floatchoice3 <float> . Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          [choice] -cl choice1,choice2. Mandatory: False. Default Value: "choice1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -choice1
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -choice.choice1.floatchoice1 <float> . Mandatory: True. Default Value: "0.125"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -choice2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • boolean: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • filename: myFilename.foo

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TileFusion.html b/python/plugins/processing/algs/otb/description/doc/TileFusion.html index 142dc73da58..ff003aa4bec 100644 --- a/python/plugins/processing/algs/otb/description/doc/TileFusion.html +++ b/python/plugins/processing/algs/otb/description/doc/TileFusion.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TileFusion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fusion of an image made of several tile files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Concatenate several tile files into a single image file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -il <string> Input tiles to concatenate (in lexicographic order : (0,0) (1,0) (0,1) (1,1)).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -cols <int32> Number of columns in the tile array. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rows <int32> Number of rows in the tile array. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -out <string> Output entire image. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • il: Scene_R1C1.tif Scene_R1C2.tif Scene_R2C1.tif Scene_R2C2.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • cols: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • rows: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • out: EntireImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TileFusion

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Fusion of an image made of several tile files.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Image Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Concatenate several tile files into a single image file.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -il <string> Input tiles to concatenate (in lexicographic order : (0,0) (1,0) (0,1) (1,1)).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -cols <int32> Number of columns in the tile array. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rows <int32> Number of rows in the tile array. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -out <string> Output entire image. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • il: Scene_R1C1.tif Scene_R1C2.tif Scene_R2C1.tif Scene_R2C2.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • cols: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • rows: 2

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • out: EntireImage.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-ann.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-ann.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-ann.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-ann.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-bayes.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-bayes.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-bayes.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-bayes.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-boost.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-boost.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-boost.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-boost.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-dt.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-dt.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-dt.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-dt.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-gbt.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-gbt.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-gbt.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-gbt.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-knn.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-knn.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-knn.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-knn.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-libsvm.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-libsvm.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-libsvm.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-libsvm.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-rf.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-rf.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-rf.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-rf.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-svm.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-svm.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-svm.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier-svm.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier.html b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier.html index 1b8afb34090..2d31847fcaa 100644 --- a/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier.html +++ b/python/plugins/processing/algs/otb/description/doc/TrainImagesClassifier.html @@ -3,9 +3,9 @@ dl { border: 3px double #ccc; padding: 0.5em; } dt { float: left; clear: left; text-align: left; font-weight: bold; color: green; } dt:after { content: ":"; } dd { margin: 0 0 0 220px; padding: 0 0 0.5em 0; }

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  TrainImagesClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Train a classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  This application performs a classifier training from multiple pairs of input images and training vector data. Samples are composed of pixel values in each band optionally centered and reduced using an XML statistics file produced by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. + The training vector data must contain polygons with a positive integer field representing the class label. The name of this field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in both lists. One parameter allows to control the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. Several classifier parameters can be set depending on the chosen classifier. In the validation process, the confusion matrix is organized the following way: rows = reference labels, columns = produced labels. In the header of the optional confusion matrix output file, the validation (reference) and predicted (produced) class labels are ordered according to the rows/columns of the confusion matrix. - This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -io <string> This group of parameters allows setting input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -sample <string> This group of parameters allows setting training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. + This application is based on LibSVM and on OpenCV Machine Learning classifiers, and is compatible with OpenCV 2.3.1 and later.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -io <string> This group of parameters allows to set input and output data.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -sample <string> This group of parameters allows to set training and validation sample lists parameters.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [choice] -classifier Choice of the classifier to use for the training. libsvm,svm,boost,dt,gbt,ann,bayes,rf,knn. Mandatory: True. Default Value: "libsvm"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -libsvm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.libsvm.opt <boolean> SVM parameters optimization flag.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -svm
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.m <string> Type of SVM formulation.. Mandatory: True. Default Value: "csvc"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.k <string> SVM Kernel Type.. Mandatory: True. Default Value: "linear"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.c <float> SVM models have a cost parameter C (1 by default) to control the trade-off between training errors and forcing rigid margins.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.nu <float> Parameter nu of a SVM optimization problem.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.coef0 <float> Parameter coef0 of a kernel function (POLY / SIGMOID).. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.gamma <float> Parameter gamma of a kernel function (POLY / RBF / SIGMOID).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.degree <float> Parameter degree of a kernel function (POLY).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.svm.opt <boolean> SVM parameters optimization flag. -If set to True, then the optimal SVM parameters will be estimated. Parameters are considered optimal by OpenCV when the cross-validation estimate of the test set error is minimal. Finally, the SVM training process is computed 10 times with these optimal parameters over subsets corresponding to 1/10th of the training samples using the k-fold cross-validation (with k = 10). -If set to False, the SVM classification process will be computed once with the currently set input SVM parameters over the training samples. -Thus, even with identical input SVM parameters and a similar random seed, the output SVM models will be different according to the method used (optimized or not) because the samples are not identically processed within OpenCV.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -boost
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.t <string> Type of Boosting algorithm.. Mandatory: True. Default Value: "real"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.w <int32> The number of weak classifiers.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.r <float> A threshold between 0 and 1 used to save computational time. Samples with summary weight <= (1 - weight_trim_rate) do not participate in the next iteration of training. Set this parameter to 0 to turn off this functionality.. Mandatory: True. Default Value: "0.95"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.boost.m <int32> Maximum depth of the tree.. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -dt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "65535"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.min <int32> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.ra <float> . Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.f <int32> If cv_folds > 1, then it prunes a tree with K-fold cross-validation where K is equal to cv_folds.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.r <boolean> If true, then a pruning will be harsher. This will make a tree more compact and more resistant to the training data noise but a bit less accurate.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.dt.t <boolean> If true, then pruned branches are physically removed from the tree.. Mandatory: False. Default Value: "True"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -gbt
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.w <int32> Number "w" of boosting algorithm iterations, with w*K being the total number of trees in the GBT model, where K is the output number of classes.. Mandatory: True. Default Value: "200"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.s <float> Regularization parameter.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.p <float> Portion of the whole training set used for each algorithm iteration. The subset is generated randomly.. Mandatory: True. Default Value: "0.8"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.gbt.max <int32> The training algorithm attempts to split each node while its depth is smaller than the maximum possible depth of the tree. The actual depth may be smaller if the other termination criteria are met, and/or if the tree is pruned.. Mandatory: True. Default Value: "3"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -ann
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.t <string> Type of training method for the multilayer perceptron (MLP) neural network.. Mandatory: True. Default Value: "reg"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.sizes <string> The number of neurons in each intermediate layer (excluding input and output layers).. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.f <string> Neuron activation function.. Mandatory: True. Default Value: "sig"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.a <float> Alpha parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.b <float> Beta parameter of the activation function (used only with sigmoid and gaussian functions).. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpdw <float> Strength of the weight gradient term in the BACKPROP method. The recommended value is about 0.1.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.bpms <float> Strength of the momentum term (the difference between weights on the 2 previous iterations). This parameter provides some inertia to smooth the random fluctuations of the weights. It can vary from 0 (the feature is disabled) to 1 and beyond. The value 0.1 or so is good enough.. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdw <float> Initial value Delta_0 of update-values Delta_{ij} in RPROP method (default = 0.1).. Mandatory: True. Default Value: "0.1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.rdwm <float> Update-values lower limit Delta_{min} in RPROP method. It must be positive (default = 1e-7).. Mandatory: True. Default Value: "1e-07"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.term <string> Termination criteria.. Mandatory: True. Default Value: "all"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.eps <float> Epsilon value used in the Termination criteria.. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [param] -classifier.ann.iter <int32> Maximum number of iterations used in the Termination criteria.. Mandatory: True. Default Value: "1000"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [group] -bayes
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -rf
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.max <int32> The depth of the tree. A low value will likely underfit and conversely a high value will likely overfit. The optimal value can be obtained using cross validation or other suitable methods.. Mandatory: True. Default Value: "5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.min <int32> If the number of samples in a node is smaller than this parameter, then the node will not be split. A reasonable value is a small percentage of the total data e.g. 1 percent.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.ra <float> If all absolute differences between an estimated value in a node and the values of the train samples in this node are smaller than this regression accuracy parameter, then the node will not be split.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.cat <int32> Cluster possible values of a categorical variable into K <= cat clusters to find a suboptimal split.. Mandatory: True. Default Value: "10"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.var <int32> The size of the subset of features, randomly selected at each tree node, that are used to find the best split(s). If you set it to 0, then the size will be set to the square root of the total number of features.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.nbtrees <int32> The maximum number of trees in the forest. Typically, the more trees you have, the better the accuracy. However, the improvement in accuracy generally diminishes and reaches an asymptote for a certain number of trees. Also to keep in mind, increasing the number of trees increases the prediction time linearly.. Mandatory: True. Default Value: "100"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.rf.acc <float> Sufficient accuracy (OOB error).. Mandatory: True. Default Value: "0.01"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] -knn
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] -classifier.knn.k <int32> The number of neighbors to use.. Mandatory: True. Default Value: "32"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          OpenCV documentation for machine learning http://docs.opencv.org/modules/ml/doc/ml.html

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.il: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.imstat: EstimateImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mv: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.mt: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vtr: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.edg: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • sample.vfn: Class

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier: libsvm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.k: linear

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.c: 1

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • classifier.libsvm.opt: false

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.out: svmModelQB1.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • io.confmatout: svmConfusionMatrixQB1.csv

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainOGRLayersClassifier.html b/python/plugins/processing/algs/otb/description/doc/TrainOGRLayersClassifier.html new file mode 100644 index 00000000000..551a2cd4544 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/TrainOGRLayersClassifier.html @@ -0,0 +1,5 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          TrainOGRLayersClassifier

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Train a SVM classifier based on labeled geometries and a list of features to consider.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          This application trains a SVM classifier based on labeled geometries and a list of features to consider for classification.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inshp <string> Name of the input shapefile. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -instats <string> XML file containing mean and variance of each feature.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outsvm <string> Output model filename.. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -cfield <string> Field containing the class id for supervision. Only geometries with this field available will be taken into account.. Mandatory: True. Default Value: "class"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [choice] -feat List of features to consider for classification. . Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Experimental. For now only shapefiles are supported. Tuning of SVM classifier is not available.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            David Youssefi during internship at CNES

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            OGRLayerClassifier,ComputeOGRLayersFeaturesStatistics

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • inshp: vectorData.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • instats: meanVar.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • outsvm: svmModel.svm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • feat: perimeter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • cfield: predicted

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/TrainSVMImagesClassifier.html b/python/plugins/processing/algs/otb/description/doc/TrainSVMImagesClassifier.html deleted file mode 100644 index e5d8776139d..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/TrainSVMImagesClassifier.html +++ /dev/null @@ -1,3 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Train SVM classifier from multiple image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Train a SVM classifier from multiple pairs of images and training vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            This application performs SVM classifier training from multiple pairs of input images and training vector data.Samples are composed of pixel values in each band optionally centered and reduced using XML statistics file produce by the ComputeImagesStatistics application. - The training vector data must contain polygons with a positive integer field representing the class label. Name of the field can be set using the "Class label field" parameter. Training and validation sample lists are built such that each class is equally represented in the two lists. One parameter allows controlling the ratio between the number of samples in training and validation sets. Two parameters allow to manage the size of the training and validation sets per class and per image. - Several SVM classifier parameters cas be set. The kernel function which defined the feature space (for example if the kernel is a Gaussian radial basis function kernel the corresponding feature space of infinite dimensions). To allow some flexibility in separating the classes, SVM models have a cost parameter, C, that controls the trade off between allowing training errors and forcing rigid margins. It creates a soft margin that permits some misclassifications. Increasing the value of C increases the cost of misclassifying points and forces the creation of a more accurate model that may not generalize well. Classifier parameters can also be optimize.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] Input and output data (-io): This group of parameters allows setting input and output data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Input Image List (-il): A list of input images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Vector Data List (-vd): A list of vector data sample used to train the estimator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] DEM repository (-dem): Path to SRTM repository

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] XML image statistics file (-imstat): Filename of an XML file containing mean and standard deviation of input images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Output SVM model (-out): Output SVM model


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] Training and validation samples parameters (-sample): This group of parameters allows setting training and validation sample lists parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Maximum training sample size (-mt): Maximum size of the training sample (default = -1).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Maximum validation sample size (-mv): Maximum size of the validation sample (default = -1)

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] training and validation sample ratio (-vtr): Ratio between training and validation sample (0.0 = all training, 1.0 = all validation) default = 0.5.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [param] Name of the discrimination field (-vfn): Name of the field using to discriminate class in the vector data files.


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            • [group] SVM classifier parameters (-svm): This group of parameters allows setting SVM classifier parameters.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              • [choice] SVM Kernel Type (-k): SVM Kernel Type.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                • [group] Linear:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  • [group] Gaussian radial basis function:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [group] Polynomial:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [group] Sigmoid:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] Control trade off between training errors and forcing rigid margins. (-c): SVM models have a cost parameter C.(1 by default).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • [param] parameters optimization (-opt): SVM parameters optimization


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Input Image List: QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Vector Data List: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • XML image statistics file: clImageStatisticsQB1.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output SVM model: svmModelQB1_allOpt.svm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Maximum validation sample size: 100

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • training and validation sample ratio: 0.5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • parameters optimization: true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • otbcli_TrainSVMImagesClassifier -io.il QB_1_ortho.tif -io.vd VectorData_QB1.shp -io.imstat clImageStatisticsQB1.xml -io.out svmModelQB1_allOpt.svm -sample.mv 100 -sample.vtr 0.5 -svm.opt true

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    diff --git a/python/plugins/processing/algs/otb/description/doc/ValidateSVMImagesClassifier.html b/python/plugins/processing/algs/otb/description/doc/ValidateSVMImagesClassifier.html deleted file mode 100644 index 041ee91a051..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/ValidateSVMImagesClassifier.html +++ /dev/null @@ -1,3 +0,0 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Validate SVM Images Classifier Application

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Estimate the performance of the SVM model with a new set of validation samples and another image.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Learning

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Estimate the performance of the SVM model obtained by the ImagesSVMClassifier with a new set of validation samples and another image. - The application asks for images statisctics as input (XML file generated with the ComputeImagesStatistics application) and a SVM model (text file) generated with the ImagesSVMClassifier application. - It will compute the global confusion matrix and kappa index and also the precision, recall and F-score of each class.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] Input Image List (-il): Input image list filename.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] Vector Data List (-vd): Vector Data of samples used to validate the estimator.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] DEM repository (-dem): Path to DEM repository.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] XML image statistics file (-imstat): Filename of an XML file containing mean and standard deviation of input images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] Output filename (-out): Filename, which contains the performances of the SVM model.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] SVM validation filename (-svm): SVM model to validate (given by TrainSVMImagesClassification output for instance).

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Parameters to set value:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Input Image List: Classification/QB_1_ortho.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Vector Data List: VectorData_QB1_bis.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • XML image statistics file: clImageStatisticsQB123.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output filename: PerformanceEstimationQB123.txt

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • SVM validation filename: clsvmModelQB123.svm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Command line to execute:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • otbcli_ValidateSVMImagesClassifier -il Classification/QB_1_ortho.tif -vd VectorData_QB1_bis.shp -imstat clImageStatisticsQB123.xml -out PerformanceEstimationQB123.txt -svm clsvmModelQB123.svm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataDSValidation.html b/python/plugins/processing/algs/otb/description/doc/VectorDataDSValidation.html index dcc02ceb53f..e2cd2032ac0 100644 --- a/python/plugins/processing/algs/otb/description/doc/VectorDataDSValidation.html +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataDSValidation.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataDSValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector data validation based on the fusion of features using Dempster-Shafer evidence theory framework.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application validates or unvalidate the studied samples using the Dempster-Shafer theory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input vector data to validate. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -descmod <string> Fuzzy descriptors model (xml file). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -belsup <string> Dempster Shafer study hypothesis to compute belief. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -plasup <string> Dempster Shafer study hypothesis to compute plausibility. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -cri <string> Dempster Shafer criterion (by default (belief+plausibility)/2). Mandatory: False. Default Value: "((Belief + Plausibility)/2.)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -thd <float> Criterion threshold (default 0.5). Mandatory: False. Default Value: "0.5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output VectorData containing only the validated samples. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    http://en.wikipedia.org/wiki/Dempster-Shafer_theory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • belsup: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • descmod: DSFuzzyModel.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataDSValidation.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataDSValidation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector data validation based on the fusion of features using Dempster-Shafer evidence theory framework.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Feature Extraction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application validates or unvalidate the studied samples using the Dempster-Shafer theory.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input vector data to validate. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -descmod <string> Fuzzy descriptors model (xml file). Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -belsup <string> Dempster Shafer study hypothesis to compute belief. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -plasup <string> Dempster Shafer study hypothesis to compute plausibility. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -cri <string> Dempster Shafer criterion (by default (belief+plausibility)/2). Mandatory: False. Default Value: "((Belief + Plausibility)/2.)"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -thd <float> Criterion threshold (default 0.5). Mandatory: False. Default Value: "0.5"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output VectorData containing only the validated samples. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    http://en.wikipedia.org/wiki/Dempster-Shafer_theory

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • belsup: cdbTvComputePolylineFeatureFromImage_LI_NOBUIL_gt.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • descmod: DSFuzzyModel.xml

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataDSValidation.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROI.html b/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROI.html new file mode 100644 index 00000000000..1dc973775ae --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROI.html @@ -0,0 +1,5 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataExtractROI

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Perform an extract ROI on the input vector data according to the input image extent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application extracts the vector data features belonging to a region specified by the support image envelope. Any features intersecting the support region is copied to output. The output geometries are NOT cropped.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -io <string> Group containing input and output parameters. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.vd: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.out: apTvUtVectorDataExtractROIApplicationTest.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROIApplication.html b/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROIApplication.html deleted file mode 100644 index f197d95ba67..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/VectorDataExtractROIApplication.html +++ /dev/null @@ -1,5 +0,0 @@ - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataExtractROIApplication

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Perform an extract ROI on the input vector data according to the input image extent

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application extracts the vector data features belonging to a region specified by the support image envelope

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -io <string> Group containing input and output parameters. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.vd: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • io.out: apTvUtVectorDataExtractROIApplicationTest.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-image.html b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-image.html new file mode 100644 index 00000000000..8c22a821a17 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-image.html @@ -0,0 +1,7 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataReprojection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user specified map projection +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry,Vector Data Manipulation,Coordinates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user given map projection. + If given, image keywordlist can be added to reprojected vectordata.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj: image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj.image.in: ROI_QB_MUL_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.vd: reprojected_vd.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-user.html b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-user.html new file mode 100644 index 00000000000..8c22a821a17 --- /dev/null +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection-user.html @@ -0,0 +1,7 @@ + + +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataReprojection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user specified map projection +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry,Vector Data Manipulation,Coordinates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user given map projection. + If given, image keywordlist can be added to reprojected vectordata.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj: image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj.image.in: ROI_QB_MUL_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.vd: reprojected_vd.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection.html b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection.html index e7c542a6368..8c22a821a17 100644 --- a/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection.html +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataReprojection.html @@ -2,6 +2,6 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataReprojection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows reprojecting a vector data using support image projection reference, or a user specified map projection -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry,Vector Data Manipulation,Coordinates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows reprojecting a vector data using support image projection reference, or a user given map projection. - If given, image keywordlist can be added to reprojected vectordata.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows managing elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj: image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj.image.in: ROI_QB_MUL_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.vd: reprojected_vd.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataReprojection

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user specified map projection +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry,Vector Data Manipulation,Coordinates

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows to reproject a vector data using support image projection reference, or a user given map projection. + If given, image keywordlist can be added to reprojected vectordata.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> . Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -elev <string> This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff. DownloadSRTMTiles application could be a useful tool to list/download tiles related to a product.. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in.vd: VectorData_QB1.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj: image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.proj.image.in: ROI_QB_MUL_1.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out.vd: reprojected_vd.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataSetField.html b/python/plugins/processing/algs/otb/description/doc/VectorDataSetField.html index f28354e410d..34a074002ed 100644 --- a/python/plugins/processing/algs/otb/description/doc/VectorDataSetField.html +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataSetField.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataSetField

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a field in vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a specified field to a specified value on all features of a vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input Vector Data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output Vector Data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -fn <string> Field name. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -fv <string> Field value. Mandatory: True. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Doesn't work with KML files yet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataSetField.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fn: Info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fv: Sample polygon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataSetField

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a field in vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Set a specified field to a specified value on all features of a vector data.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input Vector Data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output Vector Data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -fn <string> Field name. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -fv <string> Field value. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Doesn't work with KML files yet

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract_classification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataSetField.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fn: Info

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • fv: Sample polygon

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VectorDataTransform.html b/python/plugins/processing/algs/otb/description/doc/VectorDataTransform.html index 2b64b0b78aa..ad5cda0a1e6 100644 --- a/python/plugins/processing/algs/otb/description/doc/VectorDataTransform.html +++ b/python/plugins/processing/algs/otb/description/doc/VectorDataTransform.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataTransform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Apply a transform to each vertex of the input VectorData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application performs a transformation of an input vector data transforming each vertex in the vector data. The applied transformation manages translation, rotation and scale, and can be centered or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -vd <string> Input vector data to transform. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output transformed vector data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Image needed as a support to the vector data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -transform <string> Group of parameters to define the transform. Mandatory: True. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • vd: qb_RoadExtract_easyClassification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataTransform.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.ro: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VectorDataTransform

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Apply a transform to each vertex of the input VectorData

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Vector Data Manipulation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application performs a transformation of an input vector data transforming each vertex in the vector data. The applied transformation manages translation, rotation and scale, and can be centered or not.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -vd <string> Input vector data to transform. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -out <string> Output transformed vector data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Image needed as a support to the vector data. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -transform <string> Group of parameters to define the transform. Mandatory: True. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • vd: qb_RoadExtract_easyClassification.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: qb_RoadExtract.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • out: VectorDataTransform.shp

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • transform.ro: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/VertexComponentAnalysis.html b/python/plugins/processing/algs/otb/description/doc/VertexComponentAnalysis.html index 14422d1b842..345c7725e11 100644 --- a/python/plugins/processing/algs/otb/description/doc/VertexComponentAnalysis.html +++ b/python/plugins/processing/algs/otb/description/doc/VertexComponentAnalysis.html @@ -2,4 +2,4 @@ -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VertexComponentAnalysis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Find endmembers in hyperspectral images with Vertex Component Analysis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hyperspectral,Dimensionality Reduction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Applies the Vertex Component Analysis to an hyperspectral image to extract endmembers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input hyperspectral data cube. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -ne <int32> The number of endmembers to extract from the data cube. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outendm <string> The endmebers, stored in a one-line multi-spectral image, each pixel representing an endmember. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: cupriteSubHsi.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ne: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outendm: VertexComponentAnalysis.tif double

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    VertexComponentAnalysis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Brief Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Find endmembers in hyperspectral images with Vertex Component Analysis

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tags

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Hyperspectral,Dimensionality Reduction

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Long Description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Applies the Vertex Component Analysis to an hyperspectral image to extract endmembers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -in <string> Input hyperspectral data cube. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -ne <int32> The number of endmembers to extract from the data cube. Mandatory: True. Default Value: "1"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outendm <string> The endmebers, stored in a one-line multi-spectral image, each pixel representing an endmember. Mandatory: True. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -rand <int32> Set specific seed. with integer value.. Mandatory: False. Default Value: "0"
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -inxml <string> Load otb application from xml file. Mandatory: False. Default Value: ""
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • [param] -outxml <string> Save otb application to xml file. Mandatory: False. Default Value: ""

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    None

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OTB-Team

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See Also

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example of use

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • in: cupriteSubHsi.tif

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • ne: 5

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • outendm: VertexComponentAnalysis.tif double

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/python/plugins/processing/algs/otb/description/doc/WatershedSegmentation.html b/python/plugins/processing/algs/otb/description/doc/WatershedSegmentation.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/WatershedSegmentation.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Detailed description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Parameter type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Input Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter edison

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter cc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Connected components

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scale factor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Condition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Flood Level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Processing mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Output File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mask Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum object size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Layer name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tiles size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Output image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Output labeled image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Examples
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - diff --git a/python/plugins/processing/algs/otb/description/doc/WatershedSegmentationVector.html b/python/plugins/processing/algs/otb/description/doc/WatershedSegmentationVector.html deleted file mode 100644 index ad30b0c8448..00000000000 --- a/python/plugins/processing/algs/otb/description/doc/WatershedSegmentationVector.html +++ /dev/null @@ -1,1040 +0,0 @@ - - -Segmentation - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    4.9.3 Segmentation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Performs segmentation of an image, and output either a raster or a vector file. In vector mode, large input -datasets are supported. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Detailed description
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application allows performing various segmentation algorithms on an multispectral image.Available -segmentation algorithms are two different versions of Mean-Shift segmentation algorithm (one being -multi-threaded), simple pixel based connected components according to a user-defined criterion, and -watershed from the gradient of the intensity (norm of spectral bands vector). The application has two -different modes that affects the nature of its output.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the output of the application is a classical image of unique labels identifying the segmented - - -regions. The labeled output can be passed to the ColorMapping application to render regions with -contrasted colors. Please note that this mode loads the whole input image into memory, and as such can -not handle large images.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To segment large data, one can use the vector mode. In this case, the output of the application is a -vector file or database. The input image is split into tiles (whose size can be set using the tilesize -parameter), and each tile is loaded, segmented with the chosen algorithm, vectorized, and written -into the output file or database. This piece-wise behavior ensure that memory will never get -overloaded, and that images of any size can be processed. There are few more options in the vector -mode. The simplify option allows simplifying the geometry (i.e. remove nodes in polygons) -according to a user-defined tolerance. The stitch option allows applying to try to stitch -together polygons corresponding to segmented region that may have been split by the tiling -scheme. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameters
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This section describes in details the parameters available for this application. Table 4.50, page 516 -presents a summary of these parameters and the parameters keys to be used in command-line and -programming languages. Application key is Segmentation.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter key

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Parameter type

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Parameter description

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    in

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Input Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter meanshift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mean-Shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter edison

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Edison mean-shift

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter cc

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Connected components

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Watershed

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.thres

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mode convergence threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.maxiter

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Maximum number of iterations

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.meanshift.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.spatialr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Spatial radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.ranger

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Range radius

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum region size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.edison.scale

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Scale factor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.cc.expr

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Condition

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Depth Threshold

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    filter.watershed.level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Flood Level

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Processing mode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode vector

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tile-based large-scale segmentation with -vector output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode raster

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Standard segmentation with labeled raster -output

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Output File name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choices

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Writing mode for the output vector file

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulco

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, only allow to -create new layers

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Overwrite output vector file if existing.

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulovw

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, overwrite existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.outmode ulu

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Choice

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Update output vector file, update existing -layer

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.inmask

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Input image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Mask Image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.neighbor

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    8-neighbor connectivity

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.stitch

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Boolean

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Stitch polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.minsize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Minimum object size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.simplify

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Float

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Simplify polygons

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.layername

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Layer name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.fieldname

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Geometry index field name

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.tilesize

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Tiles size

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.startlabel

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Int

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Starting geometry index

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.vector.ogroptions

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		String list

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    OGR options for layer creation

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    mode.raster.out

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    		Output image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Output labeled image

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Table 4.50: Parameters table for Segmentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Input Image -The input image to segment -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation algorithm -Choice of segmentation algorithm (mean-shift by default) Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Mean-Shift: OTB implementation of the Mean-Shift algorithm (multi-threaded). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius of the neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multispectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mode convergence threshold: Algorithm iterative scheme will stop if mean-shift - vector is below this threshold or if iteration number reached maximum number of - iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Maximum number of iterations: Algorithm iterative scheme will stop if convergence - hasn’t been reached after the maximum number of iterations. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region (in pixel unit) in segmentation. - Smaller clusters will be merged to the neighboring cluster with the closest radiometry. - If set to 0 no pruning is done.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Edison mean-shift: Edison implementation of mean-shift algorithm, by its authors. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Spatial radius: Spatial radius defining neighborhood. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Range radius: Range radius defining the radius (expressed in radiometry unit) in the - multi-spectral space. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum region size: Minimum size of a region in segmentation. Smaller clusters will - be merged to the neighboring cluster with the closest radiometry. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Scale factor: Scaling of the image before processing. This is useful for images with - narrow decimal ranges (like [0,1] for instance).
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Connected components: Simple pixel-based connected-components algorithm with a user-defined - connection condition. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Condition: User defined connection condition, written as a mathematical expression. - Available variables are p(i)b(i), intensity_p(i) and distance (example of expression : - distance <10 )
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Watershed: The traditional watershed algorithm. The height function is the gradient magnitude of - the amplitude (square root of the sum of squared bands). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Depth Threshold: Depth threshold Units in percentage of the maximum depth in the - image. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Flood Level: flood level for generating the merge tree from the initial segmentation - (between 0 and 1)
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Processing mode -Choice of processing mode, either raster or large-scale. Available choices are: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Tile-based large-scale segmentation with vector output: In this mode, the application will output a - vector file or database, and process the input image piecewise. This allows performing segmentation - of very large images. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output vector file: The output vector file or database (name can be anything understood - by OGR) -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Writing mode for the output vector file: This allows setting the writing behaviour for - the output vector file. Please note that the actual behaviour depends on the file format. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Mask Image: Only pixels whose mask value is strictly positive will be segmented. - - -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • 8-neighbor connectivity: Activate 8-Neighborhood connectivity (default is 4). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Stitch polygons: Scan polygons on each side of tiles and stitch polygons which connect - by more than one pixel. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Minimum object size: Objects whose size is below the minimum object size (area in - pixels) will be ignored during vectorization. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Simplify polygons: Simplify polygons according to a given tolerance (in pixel). This - option allows reducing the size of the output file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Layer name: Name of the layer in the vector file or database (default is Layer). -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Geometry index field name: Name of the field holding the geometry index in the - output vector file or database. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Tiles size: User defined tiles size for tile-based segmentation. Optimal tile size is - selected according to available RAM if null. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Starting geometry index: Starting value of the geometry index field -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • OGR options for layer creation: A list of layer creation options in the form - KEY=VALUE that will be passed directly to OGR without any validity checking. - Options may depend on the file format, and can be found in OGR documentation.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • Standard segmentation with labeled raster output: In this mode, the application will output a - standard labeled raster. This mode can not handle large data. -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      • Output labeled image: The output labeled image.
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Examples
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 1 -Example of use with vector mode and watershed segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode vector -mode.vector.out SegmentationVector.sqlite -filter watershed -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","vector") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.vector.out", "SegmentationVector.sqlite") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","watershed") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Example 2 -Example of use with raster mode and mean-shift segmentationTo run this example in command-line, use the -following: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    otbcli_Segmentation -in QB_Toulouse_Ortho_PAN.tif -mode raster -mode.raster.out SegmentationRaster.tif uint16 -filter meanshift -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    To run this example from Python, use the following code snippet: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    #!/usr/bin/python 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # Import the otb applications package 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    import otbApplication 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line creates an instance of the Segmentation application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation = otbApplication.Registry.CreateApplication("Segmentation") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following lines set all the application parameters: 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("in", "QB_Toulouse_Ortho_PAN.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode","raster") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("mode.raster.out", "SegmentationRaster.tif") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterOutputImagePixelType("mode.raster.out", 3) 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.SetParameterString("filter","meanshift") 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    # The following line execute the application 
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Segmentation.ExecuteAndWriteOutput() -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Limitations
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    In raster mode, the application can not handle large input images. Stitching step of vector mode -might become slow with very large input images. MeanShift filter results depends on threads -number. -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    Authors
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    This application has been written by OTB-Team. - - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    See also
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    These additional ressources can be useful for further information: -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    • MeanShiftSegmentation
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    -