.. _VectorDataExtractROI: 

VectorDataExtractROI
====================





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

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

.. contents:: :local:

.. |br| raw:: html

   <br />

.. |em| raw:: html

   &emsp;

Input and output data
^^^^^^^^^^^^^^^^^^^^^



Group containing input and output parameters

**Input Vector data** :code:`-io.vd vectorfile` *Mandatory* |br|
Input vector data

**Support image** :code:`-io.in image` *Mandatory* |br|
Support image that specifies the extracted region

**Output Vector data** :code:`-io.out vectorfile` *Mandatory* |br|
Output extracted vector data

Elevation management
^^^^^^^^^^^^^^^^^^^^



This group of parameters allows managing elevation values.

**DEM directory** :code:`-elev.dem directory` |br|
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. Input DEM tiles should be in a raster format supported by GDAL.

**Geoid File** :code:`-elev.geoid filename [dtype]` |br|
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 (egm96.grd and egm96.grd.hdr at https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/-/tree/master/Data/Input/DEM).

**Default elevation** :code:`-elev.default float` *Default value: 0* |br|
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.



Examples
--------

From the command-line:

.. code-block:: bash

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


From Python:

.. code-block:: python

	import otbApplication

	app = otbApplication.Registry.CreateApplication("VectorDataExtractROI")

	app.SetParameterString("io.in", "qb_RoadExtract.tif")
	app.SetParameterString("io.vd", "qb_RoadExtract_classification.shp")
	app.SetParameterString("io.out", "apTvUtVectorDataExtractROIApplicationTest.shp")

	app.ExecuteAndWriteOutput()