QGIS/python/plugins/processing/algs/otb/description/doc/ExtractROI-standard.html

<html><head>
<style type="text/css">
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; }
</style>
</head><body><h1>ExtractROI</h1><h2>Brief Description</h2>Extract a ROI defined by the user.<h2>Tags</h2>Image Manipulation<h2>Long Description</h2>This application extracts a Region Of Interest with user defined size, or reference image.<h2>Parameters</h2><ul><li><b>[param] -in</b> &lt;string&gt; Input image.. Mandatory: True. Default Value: &quot;&quot;</li><li><b>[param] -out</b> &lt;string&gt; Output image.. Mandatory: True. Default Value: &quot;&quot;</li><li><b>[param] -ram</b> &lt;int32&gt; Available memory for processing (in MB). Mandatory: False. Default Value: &quot;128&quot;</li><li><b>[param] -startx</b> &lt;int32&gt; ROI start x position.. Mandatory: True. Default Value: &quot;0&quot;</li><li><b>[param] -starty</b> &lt;int32&gt; ROI start y position.. Mandatory: True. Default Value: &quot;0&quot;</li><li><b>[param] -sizex</b> &lt;int32&gt; size along x in pixels.. Mandatory: True. Default Value: &quot;0&quot;</li><li><b>[param] -sizey</b> &lt;int32&gt; size along y in pixels.. Mandatory: True. Default Value: &quot;0&quot;</li><b>[choice] -mode</b>  standard,fit. Mandatory: True. Default Value: &quot;standard&quot;<ul><li><b>[group] -standard</b></li><ul></ul><li><b>[group] -fit</b></li><ul><li><b>[param] -mode.fit.ref</b> &lt;string&gt; Reference image to define the ROI. Mandatory: True. Default Value: &quot;&quot;</li><li><b>[param] -mode.fit.elev</b> &lt;string&gt; 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: &quot;0&quot;</li><li><b>[param] -mode.fit.elev.dem</b> &lt;string&gt; This parameter allows selecting a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: &quot;&quot;</li><li><b>[param] -mode.fit.elev.geoid</b> &lt;string&gt; 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: &quot;&quot;</li><li><b>[param] -mode.fit.elev.default</b> &lt;float&gt; 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: &quot;0&quot;</li></ul></ul><b>[choice] -cl</b> Channels to write in the output image. . Mandatory: True. Default Value: &quot;&quot;<ul></ul></ul><h2>Limitations</h2>None<h2>Authors</h2>OTB-Team<h2>See Also</h2> <h2>Example of use</h2><ul><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">in: VegetationIndex.hd</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">startx: 40</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">starty: 250</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">sizex: 150</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">sizey: 150</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">out: ExtractROI.tif</p></li></ul></body></html>
Update OTB processing modules 2014-01-17 19:39:17 +01:00			`<html><head>`
			`<style type="text/css">`
			`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; }`
			`</style>`
spelling fixes 2014-05-17 17:35:27 +02:00			</head><body><h1>ExtractROI</h1><h2>Brief Description</h2>Extract a ROI defined by the user.<h2>Tags</h2>Image Manipulation<h2>Long Description</h2>This application extracts a Region Of Interest with user defined size, or reference image.<h2>Parameters</h2><ul><li><b>[param] -in</b> <string> Input image.. Mandatory: True. Default Value: ""</li><li><b>[param] -out</b> <string> Output image.. Mandatory: True. Default Value: ""</li><li><b>[param] -ram</b> <int32> Available memory for processing (in MB). Mandatory: False. Default Value: "128"</li><li><b>[param] -startx</b> <int32> ROI start x position.. Mandatory: True. Default Value: "0"</li><li><b>[param] -starty</b> <int32> ROI start y position.. Mandatory: True. Default Value: "0"</li><li><b>[param] -sizex</b> <int32> size along x in pixels.. Mandatory: True. Default Value: "0"</li><li><b>[param] -sizey</b> <int32> size along y in pixels.. Mandatory: True. Default Value: "0"</li><b>[choice] -mode</b> standard,fit. Mandatory: True. Default Value: "standard"<ul><li><b>[group] -standard</b></li><ul></ul><li><b>[group] -fit</b></li><ul><li><b>[param] -mode.fit.ref</b> <string> Reference image to define the ROI. Mandatory: True. Default Value: ""</li><li><b>[param] -mode.fit.elev</b> <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"</li><li><b>[param] -mode.fit.elev.dem</b> <string> This parameter allows selecting a directory containing Digital Elevation Model tiles. Mandatory: False. Default Value: ""</li><li><b>[param] -mode.fit.elev.geoid</b> <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: ""</li><li><b>[param] -mode.fit.elev.default</b> <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"</li></ul></ul><b>[choice] -cl</b> Channels to write in the output image. . Mandatory: True. Default Value: ""<ul></ul></ul><h2>Limitations</h2>None<h2>Authors</h2>OTB-Team<h2>See Also</h2> <h2>Example of use</h2><ul><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">in: VegetationIndex.hd</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">startx: 40</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">starty: 250</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">sizex: 150</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">sizey: 150</p></li><li><p style=" margin-top:0px; margin-bottom:0px; margin-left:0px; margin-right:0px; -qt-block-indent:0; text-indent:0px;">out: ExtractROI.tif</p></li></ul></body></html>