Skip to content

Commit

Permalink
[otb] add description for otb modules
Browse files Browse the repository at this point in the history 
git-svn-id: http://sextante.googlecode.com/svn/trunk/soft/bindings/qgis-plugin@78 881b9c09-3ef8-f3c2-ec3d-21d735c97f4d
  • Loading branch information
julien.malik@gmail.com committed Apr 13, 2012
1 parent 1a1d9d6 commit 08de319
Show file tree
Hide file tree
Showing 54 changed files with 676 additions and 74 deletions.
6 changes: 6 additions & 0 deletions src/sextante/otb/description/BandMath.txt
View file
@@ -0,0 +1,6 @@
otbcli_BandMath
BandMath
OTB
OutputRaster|-out|Output image.|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
ParameterString|-exp|The mathematical expression to apply. \nUse im1b1 for the first band, im1b2 for the second one...|
12 changes: 12 additions & 0 deletions src/sextante/otb/description/BundleToPerfectSensor.txt
View file
@@ -0,0 +1,12 @@
otbcli_BundleToPerfectSensor
BundleToPerfectSensor
OTB
ParameterRaster|-inp| Input panchromatic image.|True
ParameterRaster|-inxs| Input XS image.|True
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
ParameterNumber|-lms| Spacing of the deformation field. Default is 10 times the PAN image spacing.|None|None|None
OutputRaster|-out| Output image.|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
17 changes: 17 additions & 0 deletions src/sextante/otb/description/ColorMapping.txt
View file
@@ -0,0 +1,17 @@
otbcli_ColorMapping
ColorMapping
OTB
ParameterRaster|-in|Input image filename|True
OutputRaster|-out|Output image filename|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
ParameterSelection|-op|Selection of the operation to execute (default is : label to color).|labeltocolor;colortolabel;
ParameterNumber|-op.colortolabel.notfound|Label to use for unknown colors.|None|None|404
ParameterSelection|-method|Selection of color mapping methods and their parameters.|custom;continuous;optimal;image;
ParameterString|-method.custom.lut|An ASCII file containing the look-up table\nwith one color per line\n(for instance the line '1 255 0 0' means that all pixels with label 1 will be replaced by RGB color 255 0 0)\nLines beginning with a # are ignored|
ParameterSelection|-method.continuous.lut|Available look-up tables.|red;green;blue;grey;hot;cool;spring;summer;autumn;winter;copper;jet;hsv;overunder;relief;
ParameterNumber|-method.continuous.min|Set the lower input value of the mapping range.|None|None|0.0
ParameterNumber|-method.continuous.max|Set the higher input value of the mapping range.|None|None|255.0
ParameterNumber|-method.optimal.background|Value of the background label|None|None|0
ParameterRaster|-method.image.in|Support image filename. LUT is calculated using the mean af pixel value on the area. First of all image is normalized with extrema rejection|True
ParameterNumber|-method.image.low|lower quantile for image normalisation|None|None|2
ParameterNumber|-method.image.up|upper quantile for image normalisation|None|None|2
14 changes: 14 additions & 0 deletions src/sextante/otb/description/CompareImages.txt
View file
@@ -0,0 +1,14 @@
otbcli_CompareImages
CompareImages
OTB
ParameterRaster|-ref.in|Image used as reference in the comparaison|True
ParameterNumber|-ref.channel|Used channel for the reference image|None|None|1
ParameterRaster|-meas.in|Image used as measured in the comparaison|True
ParameterNumber|-meas.channel|Used channel for the measured image|None|None|1
ParameterNumber|-roi.startx|ROI start x position.|None|None|0
ParameterNumber|-roi.starty|ROI start y position.|None|None|0
ParameterNumber|-roi.sizex|size along x in pixels.|None|None|0
ParameterNumber|-roi.sizey|size along y in pixels.|None|None|0
ParameterNumber|-mse|Mean Squared Error value|None|None|None
ParameterNumber|-mae|Mean Absolute Error value|None|None|None
ParameterNumber|-psnr|Peak Signal to Noise Ratio value|None|None|None
4 changes: 4 additions & 0 deletions src/sextante/otb/description/ComputeImagesStatistics.txt
View file
@@ -0,0 +1,4 @@
otbcli_ComputeImagesStatistics
ComputeImagesStatistics
OTB
ParameterString|-out|XML filename where the statistics are saved for future reuse.|
12 changes: 12 additions & 0 deletions src/sextante/otb/description/ComputePolylineFeatureFromImage.txt
View file
@@ -0,0 +1,12 @@
otbcli_ComputePolylineFeatureFromImage
ComputePolylineFeatureFromImage
OTB
ParameterRaster|-in|An image to compute the descriptors on.|True
ParameterVector|-vd|Vector data containing the polylines where the features will be computed.|True
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
ParameterString|-expr|The feature formula (b1 < 0.3) where b1 is the standard name of input image first band|
ParameterString|-field|The field name corresponding to the feature codename (NONDVI, ROADSA...)|
OutputVector|-out|The output vector data containing polylines with a new field|
5 changes: 5 additions & 0 deletions src/sextante/otb/description/ConcatenateImages.txt
View file
@@ -0,0 +1,5 @@
otbcli_ConcatenateImages
ConcatenateImages
OTB
OutputRaster|-out|The concatenated output image|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
4 changes: 4 additions & 0 deletions src/sextante/otb/description/ConcatenateVectorData.txt
View file
@@ -0,0 +1,4 @@
otbcli_ConcatenateVectorData
ConcatenateVectorData
OTB
OutputVector|-out|Output conctenated VectorData|
13 changes: 13 additions & 0 deletions src/sextante/otb/description/ConnectedComponentSegmentation.txt
View file
@@ -0,0 +1,13 @@
otbcli_ConnectedComponentSegmentation
ConnectedComponentSegmentation
OTB
ParameterRaster|-in|The image to segment.|True
OutputVector|-out|The segmentation shape.|
ParameterString|-mask|Mask mathematical expression (only if support image is given)|
ParameterString|-expr|Formula used for connected component segmentation|
ParameterNumber|-minsize|Min object size (area in pixel)|None|None|2
ParameterString|-obia|OBIA mathematical expression|
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
7 changes: 7 additions & 0 deletions src/sextante/otb/description/Convert.txt
View file
@@ -0,0 +1,7 @@
otbcli_Convert
Convert
OTB
ParameterRaster|-in|Input image|True
ParameterSelection|-type|Transfer function for the rescaling|none;linear;log2;
OutputRaster|-out|Output image|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
14 changes: 14 additions & 0 deletions src/sextante/otb/description/ConvertCartoToGeoPoint.txt
View file
@@ -0,0 +1,14 @@
otbcli_ConvertCartoToGeoPoint
ConvertCartoToGeoPoint
OTB
ParameterNumber|-carto.x|X cartographic coordinates in the specified projection.|None|None|None
ParameterNumber|-carto.y|Y cartographic coordinates in the specified projection.|None|None|None
ParameterSelection|-mapproj|Parameters of the ouptut map projection to be used.|utm;lambert2;lambert93;transmercator;wgs;epsg;
ParameterNumber|-mapproj.utm.zone|The zone number ranges from 1 to 60 and allows to define the transverse mercator projection (along with the hemisphere)|None|None|None
ParameterBoolean|-mapproj.utm.northhem|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.|
ParameterNumber|-mapproj.transmercator.falseeasting| Transmercator false easting value.|None|None|0.0
ParameterNumber|-mapproj.transmercator.falsenorthing| Transmercator false northing value.|None|None|0.0
ParameterNumber|-mapproj.transmercator.scale| Transmercator scale factor value.|None|None|1.0
ParameterNumber|-mapproj.epsg.code|See www.spatialreference.org to find which EPSG code is associated to your projection|None|None|32631
ParameterNumber|-long|Point longitude coordinates.|None|None|None
ParameterNumber|-lat|Point latitude coordinates.|None|None|None
10 changes: 10 additions & 0 deletions src/sextante/otb/description/ConvertSensorToGeoPoint.txt
View file
@@ -0,0 +1,10 @@
otbcli_ConvertSensorToGeoPoint
ConvertSensorToGeoPoint
OTB
ParameterRaster|-in|Input sensor image.|True
ParameterNumber|-input.idx|X coordinate of the point to transform.|None|None|None
ParameterNumber|-input.idy|Y coordinate of the point to transform.|None|None|None
ParameterNumber|-output.idx|Output point longitude coordinate.|None|None|None
ParameterNumber|-output.idy|Output point latitude coordinate.|None|None|None
ParameterString|-output.town|Nearest main town of the computed geographic point.|
ParameterString|-output.country|Country of the input image|
11 changes: 11 additions & 0 deletions src/sextante/otb/description/DSFuzzyModelEstimation.txt
View file
@@ -0,0 +1,11 @@
otbcli_DSFuzzyModelEstimation
DSFuzzyModelEstimation
OTB
ParameterVector|-psin|Ground truth vector data for positive samples|True
ParameterVector|-nsin|Ground truth vector data for negative samples|True
ParameterString|-cri|Dempster Shafer criterion (by default (belief+plausibility)/2)|((Belief + Plausibility)/2.)
ParameterNumber|-wgt|Coefficient between 0 and 1 to promote undetection or false detections (default 0.5)|None|None|0.5
ParameterString|-initmod|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)|
ParameterNumber|-maxnbit|Maximum number of optimizer iteration (default 200)|None|None|200
ParameterBoolean|-optobs|Activate the optimizer observer|
ParameterString|-out|Output model file name (xml file) contains the optimal model to perform informations fusion.|
10 changes: 10 additions & 0 deletions src/sextante/otb/description/ExtractROI.txt
View file
@@ -0,0 +1,10 @@
otbcli_ExtractROI
ExtractROI
OTB
ParameterRaster|-in|Input image.|True
OutputRaster|-out|Output image.|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
ParameterNumber|-startx|ROI start x position.|None|None|0
ParameterNumber|-starty|ROI start y position.|None|None|0
ParameterNumber|-sizex|size along x in pixels.|None|None|0
ParameterNumber|-sizey|size along y in pixels.|None|None|0
25 changes: 25 additions & 0 deletions src/sextante/otb/description/FineRegistration.txt
View file
@@ -0,0 +1,25 @@
otbcli_FineRegistration
FineRegistration
OTB
ParameterRaster|-ref|The reference image.|True
ParameterRaster|-sec|The secondary image.|True
OutputRaster|-out|The output image.|
ParameterNumber|-erx|The exploration radius along x (in pixels)|None|None|None
ParameterNumber|-ery|The exploration radius along y (in pixels)|None|None|None
ParameterNumber|-mrx|Radius along x (in pixels) of the metric computation window|None|None|None
ParameterNumber|-mry|Radius along y (in pixels) of the metric computation window|None|None|None
ParameterRaster|-w|The image to warp after disparity estimation is completed|False
OutputRaster|-wo|The output warped image|
ParameterNumber|-cox|Coarse offset along x (in physical space) between the two images|None|None|0.0
ParameterNumber|-coy|Coarse offset along y (in physical space) between the two images|None|None|0.0
ParameterNumber|-ssrx|Generates a result at a coarser resolution with a given sub-sampling rate along X|None|None|1.0
ParameterNumber|-ssry|Generates a result at a coarser resolution with a given sub-sampling rate along Y|None|None|1.0
ParameterNumber|-rgsx|Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in X direction.|None|None|None
ParameterNumber|-rgsy|Performs a gaussian smoothing of the reference image. Parameter is gaussian sigma (in pixels) in Y direction.|None|None|None
ParameterNumber|-sgsx|Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in X direction.|None|None|None
ParameterNumber|-sgsy|Performs a gaussian smoothing of the secondary image. Parameter is gaussian sigma (in pixels) in Y direction.|None|None|None
ParameterString|-m|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|
ParameterNumber|-spa|Metric extrema location will be refined up to the given accuracy. Default is 0.01|None|None|0.00999999977648
ParameterNumber|-vmlt|Lower threshold to obtain a validity mask.|None|None|None
ParameterNumber|-vmut|Upper threshold to obtain a validity mask.|None|None|None
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
17 changes: 17 additions & 0 deletions src/sextante/otb/description/GridBasedImageResampling.txt
View file
@@ -0,0 +1,17 @@
otbcli_GridBasedImageResampling
GridBasedImageResampling
OTB
ParameterRaster|-io.in|The input image to resample|True
OutputRaster|-io.out|The resampled output image|
ParameterRaster|-grid.in|The resampling grid|True
ParameterSelection|-grid.type|Allows to choose between two grid types|def;loc;
ParameterNumber|-out.ulx|X Coordinate of the upper-left pixel of the output resampled image|None|None|0.0
ParameterNumber|-out.uly|Y Coordinate of the upper-left pixel of the output resampled image|None|None|0.0
ParameterNumber|-out.sizex|Size of the output resampled image along X (in pixels)|None|None|None
ParameterNumber|-out.sizey|Size of the output resampled image along Y (in pixels)|None|None|None
ParameterNumber|-out.spacingx|Size of each pixel along X axis|None|None|1.0
ParameterNumber|-out.spacingy|Size of each pixel along Y axis|None|None|1.0
ParameterNumber|-out.default|The default value to give to pixel that falls outside of the input image.|None|None|0.0
ParameterSelection|-interpolator|This group of parameters allows to define how the input image will be interpolated during resampling.|nn;linear;bco;
ParameterNumber|-interpolator.bco.radius|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.|None|None|2
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
13 changes: 13 additions & 0 deletions src/sextante/otb/description/HooverCompareSegmentation.txt
View file
@@ -0,0 +1,13 @@
otbcli_HooverCompareSegmentation
HooverCompareSegmentation
OTB
ParameterRaster|-ingt|A partial ground truth segmentation image.|True
ParameterRaster|-inms|A machine segmentation image.|True
ParameterNumber|-bg|Label value of the background in the input segmentations|None|None|0
ParameterNumber|-th|Overlapping threshold used to find Hoover instances.|None|None|0.75
OutputRaster|-outgt|The colored ground truth output image.|
OutputRaster|-outms|The colored machine segmentation output image.|
ParameterNumber|-rc|Overall score for correct detection (RC)|None|None|None
ParameterNumber|-rf|Overall score for over segmentation (RF)|None|None|None
ParameterNumber|-ra|Overall score for under segmentation (RA)|None|None|None
ParameterNumber|-rm|Overall score for missed detection (RM)|None|None|None
7 changes: 7 additions & 0 deletions src/sextante/otb/description/HyperspectralUnmixing.txt
View file
@@ -0,0 +1,7 @@
otbcli_HyperspectralUnmixing
HyperspectralUnmixing
OTB
ParameterRaster|-in|The hyperspectral data cube to unmix|True
OutputRaster|-out|The output abundance map|
ParameterRaster|-ie|The endmembers (estimated pure pixels) to use for unmixing. Must be stored as a multispectral image, where each pixel is interpreted as an endmember|True
ParameterSelection|-ua|The algorithm to use for unmixing|ucls;ncls;isra;mdmdnmf;
10 changes: 10 additions & 0 deletions src/sextante/otb/description/ImageEnvelope.txt
View file
@@ -0,0 +1,10 @@
otbcli_ImageEnvelope
ImageEnvelope
OTB
ParameterRaster|-in|Input image.|True
OutputVector|-out|Vector data file containing the envelope|
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
ParameterString|-proj|Projection to be used to compute the envelope (default is WGS84)|
9 changes: 9 additions & 0 deletions src/sextante/otb/description/ImageSVMClassifier.txt
View file
@@ -0,0 +1,9 @@
otbcli_ImageSVMClassifier
ImageSVMClassifier
OTB
ParameterRaster|-in|The input image to classify.|True
ParameterRaster|-mask|The mask allows to restrict classification of the input image to the area where mask pixel values are greater than 0.|False
ParameterString|-svm|A SVM model file (*.svm extension, produced by TrainSVMImagesClassifier application).|
ParameterString|-imstat|A XML file containing mean and standard deviation to center and reduce samples before classification (produced by ComputeImagesStatistics application).|
OutputRaster|-out|Output image containing class labels|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
12 changes: 12 additions & 0 deletions src/sextante/otb/description/KMeansClassification.txt
View file
@@ -0,0 +1,12 @@
otbcli_KMeansClassification
KMeansClassification
OTB
ParameterRaster|-in|Input image to classify.|True
OutputRaster|-out|Output image containing the class indexes.|
ParameterNumber|-ram|Available memory for processing (in MB)|None|None|128
ParameterRaster|-vm|Validity mask. Only non-zero pixels will be used to estimate KMeans modes.|False
ParameterNumber|-ts|Size of the training set (in pixels).|None|None|100
ParameterNumber|-nc|Number of modes, which will be used to generate class membership.|None|None|5
ParameterNumber|-maxit|Maximum number of iterations for the learning step.|None|None|1000
ParameterNumber|-ct|Convergence threshold for class centroid (L2 distance, by default 0.01).|None|None|9.99999974738e-05
ParameterString|-outmeans|Output text file containing centroid positions|
12 changes: 12 additions & 0 deletions src/sextante/otb/description/KmzExport.txt
View file
@@ -0,0 +1,12 @@
otbcli_KmzExport
KmzExport
OTB
ParameterRaster|-in|Input image|True
ParameterString|-out|Output Kmz product directory (with .kmz extension)|
ParameterNumber|-tilesize|Size of the tiles in the kmz product, in number of pixels.|None|None|None
ParameterRaster|-logo|Path to the image logo to add to the KMZ product.|False
ParameterRaster|-legend|Path to the image legend to add to the KMZ product.|False
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
10 changes: 10 additions & 0 deletions src/sextante/otb/description/LineSegmentDetection.txt
View file
@@ -0,0 +1,10 @@
otbcli_LineSegmentDetection
LineSegmentDetection
OTB
ParameterRaster|-in| Input image on which lines while be detected.|True
OutputVector|-out| Output detected line segments (vector data).|
ParameterSelection|-elev|This group of parameters allows to manage elevation values. Supported formats are SRTM, DTED or any geotiff processed by the DEM import application|dem;average;
ParameterString|-elev.dem.path|This parameter allows to select a directory containing Digital Elevation Model tiles|
ParameterString|-elev.dem.geoid|Use a geoid grid to get the height above the ellipsoid used|
ParameterNumber|-elev.average.value|This parameter allows to pick up an average elevation for all the points of the image.|None|None|0.0
ParameterBoolean|-norescale|By default, the input image amplitude is rescaled between [0,255]. Turn on this parameter to skip rescaling|
5 changes: 5 additions & 0 deletions src/sextante/otb/description/MaximumAutocorrelationFactor.txt
View file
@@ -0,0 +1,5 @@
otbcli_MaximumAutocorrelationFactor
MaximumAutocorrelationFactor
OTB
ParameterRaster|-in|The input image to apply MAF decomposition on.|True
OutputRaster|-out|MAF decomposition of the input image. Components are ordered by decreasing eigenvalues.|
12 changes: 12 additions & 0 deletions src/sextante/otb/description/MeanShiftSegmentation.txt
View file
@@ -0,0 +1,12 @@
otbcli_MeanShiftSegmentation
MeanShiftSegmentation
OTB
ParameterRaster|-in|The input image.|True
OutputRaster|-fout|The filtered output image.|
OutputRaster|-cout|The clustered output image.|
OutputRaster|-lout|The label output image.|
OutputRaster|-cbout|The cluster boundaries output image.|
ParameterNumber|-spatialr|Spatial radius defining neighborhood.|None|None|5
ParameterNumber|-ranger|Range radius defining the interval in the color space.|None|None|15.0
ParameterNumber|-minsize|Minimun size of a region to be kept after clustering.|None|None|100
ParameterNumber|-scale|Scale to stretch the image before processing.|None|None|100000.0

0 comments on commit 08de319

Please sign in to comment.