5.1.6 Extract ROI

Extract a ROI defined by the user.

Detailed description

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

Parameters

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




Parameter key

Parameter type

Parameter description




in

Input image

Input Image

out

Output image

Output Image

ram

Int

Available RAM (Mb)

mode

Choices

Extraction mode

mode standard

Choice

Standard

mode fit

Choice

Fit

mode.fit.ref

Input image

Reference image

mode.fit.elev

Group

Elevation management

mode.fit.elev.dem

Directory

DEM directory

mode.fit.elev.geoid

Input File name

Geoid File

mode.fit.elev.default

Float

Default elevation

startx

Int

Start X

starty

Int

Start Y

sizex

Int

Size X

sizey

Int

Size Y

cl

List

Output Image channels

inxml

XML input parameters file

Load otb application from xml file

outxml

XML output parameters file

Save otb application to xml file








Figure 5.6: Parameters table for Extract ROI.

Input Image Input image.

Output Image Output image.

Available RAM (Mb) Available memory for processing (in MB)

Extraction mode Available choices are:

Start X ROI start x position.

Start Y ROI start y position.

Size X size along x in pixels.

Size Y size along y in pixels.

Output Image channels Channels to write in the output image.

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_ExtractROI -in VegetationIndex.hd -startx 40 -starty 250 -sizex 150 -sizey 150 -out ExtractROI.tif

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 ExtractROI application 
ExtractROI = otbApplication.Registry.CreateApplication("ExtractROI") 
 
# The following lines set all the application parameters: 
ExtractROI.SetParameterString("in", "VegetationIndex.hd") 
 
ExtractROI.SetParameterInt("startx", 40) 
 
ExtractROI.SetParameterInt("starty", 250) 
 
ExtractROI.SetParameterInt("sizex", 150) 
 
ExtractROI.SetParameterInt("sizey", 150) 
 
ExtractROI.SetParameterString("out", "ExtractROI.tif") 
 
# The following line execute the application 
ExtractROI.ExecuteAndWriteOutput()

Limitations

None

Authors

This application has been written by OTB-Team.