VectorDataExtractROI - VectorData Extract ROI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Perform an extract ROI on the input vector data according to the input image extent

Detailed 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
----------

This section describes in details the parameters available for this application. Table [#]_ presents a summary of these parameters and the parameters keys to be used in command-line and programming languages. Application key is *VectorDataExtractROI* .

.. [#] Table: Parameters table for VectorData Extract ROI.

+-------------+----------------------------------+--------------------------+
|Parameter Key|Parameter Name                    |Parameter Type            |
+=============+==================================+==========================+
|io           |Input and output data             |Group                     |
+-------------+----------------------------------+--------------------------+
|io.vd        |Input Vector data                 |Input vector data         |
+-------------+----------------------------------+--------------------------+
|io.in        |Support image                     |Input image               |
+-------------+----------------------------------+--------------------------+
|io.out       |Output Vector data                |Output vector data        |
+-------------+----------------------------------+--------------------------+
|elev         |Elevation management              |Group                     |
+-------------+----------------------------------+--------------------------+
|elev.dem     |DEM directory                     |Directory                 |
+-------------+----------------------------------+--------------------------+
|elev.geoid   |Geoid File                        |Input File name           |
+-------------+----------------------------------+--------------------------+
|elev.default |Default elevation                 |Float                     |
+-------------+----------------------------------+--------------------------+
|inxml        |Load otb application from xml file|XML input parameters file |
+-------------+----------------------------------+--------------------------+
|outxml       |Save otb application to xml file  |XML output parameters file|
+-------------+----------------------------------+--------------------------+

**[Input and output data]**: Group containing input and output parameters.

- **Input Vector data**: Input vector data.
- **Support image**: Support image that specifies the extracted region.
- **Output Vector data**: Output extracted vector data.

**[Elevation management]**: This group of parameters allows managing 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.

- **DEM directory**: This parameter allows selecting a directory containing Digital Elevation Model files. Note that this directory should contain only DEM files. Unexpected behaviour might occurs if other images are found in this directory.
- **Geoid File**: 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).
- **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.

**Load otb application from xml file**: Load otb application from xml file.

**Save otb application to xml file**: Save otb application to xml file.



Example
-------

To run this example in command-line, use the following: 
::

	otbcli_VectorDataExtractROI -io.in qb_RoadExtract.tif -io.vd qb_RoadExtract_classification.shp -io.out apTvUtVectorDataExtractROIApplicationTest.shp

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 VectorDataExtractROI application 
	VectorDataExtractROI = otbApplication.Registry.CreateApplication("VectorDataExtractROI")

	# The following lines set all the application parameters:
	VectorDataExtractROI.SetParameterString("io.in", "qb_RoadExtract.tif")

	VectorDataExtractROI.SetParameterString("io.vd", "qb_RoadExtract_classification.shp")

	VectorDataExtractROI.SetParameterString("io.out", "apTvUtVectorDataExtractROIApplicationTest.shp")

	# The following line execute the application
	VectorDataExtractROI.ExecuteAndWriteOutput()

Limitations
~~~~~~~~~~~

None

Authors
~~~~~~~

This application has been written by OTB-Team.