OTB.ExtractROI: Extract a ROI defined by the user.

This application extracts a Region Of Interest with user parameters. There are four mode of extraction. The standard mode allows the user to enter one point (upper left corner of the region to extract) and a size. The extent mode needs two points (upper left corner and lower right) and the radius mode need the center of the region and the radius : it will extract the rectangle containing the circle defined and limited by the image dimension. The fit mode needs a reference image or vector and the dimension of the extracted region will be the same as the extent of the reference. Different units are available such as pixel, image physical space or longitude and latitude.

Inputs

Image to be processed.

format
href
Please set a value for in.

Region of interest from the input image

string
Please set a value for out.

mode

string
Please set a value for mode.

Reference image to define the ROI

format
href
Please set a value for mode.fit.im.

The extent of the input vector file is computed and then gives a region of interest that will be extracted.

format
href
Please set a value for mode.fit.vect.

X coordinate of upper left corner point.

number
Please set a value for mode.extent.ulx.

Y coordinate of upper left corner point.

number
Please set a value for mode.extent.uly.

X coordinate of lower right corner point.

number
Please set a value for mode.extent.lrx.

Y coordinate of lower right corner point.

number
Please set a value for mode.extent.lry.

mode.extent.unit

string
Please set a value for mode.extent.unit.

This is the radius parameter of the radius mode.

number
Please set a value for mode.radius.r.

mode.radius.unitr

string
Please set a value for mode.radius.unitr.

This is the center coordinate of the radius mode, it will be either an ordinate or a latitude.

number
Please set a value for mode.radius.cx.

mode.radius.cy

number
Please set a value for mode.radius.cy.

mode.radius.unitc

string
Please set a value for mode.radius.unitc.

ROI start x position.

integer
Please set a value for startx.

ROI start y position.

integer
Please set a value for starty.

size along x in pixels.

integer
Please set a value for sizex.

size along y in pixels.

integer
Please set a value for sizey.

Channels to write in the output image.

string
Please set a value for cl.

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.

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(https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-data/blob/master/Input/DEM/egm96.grd).

format
href
Please set a value for elev.geoid.

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.

number
Please set a value for elev.default.

Available memory for processing (in MB)

integer

Outputs

Region of interest from the input image

format
transmission

Execution options

successUri
inProgressUri
failedUri

format

mode

Execute End Point

View the execution endpoint of a process.

View the alternative version in HTML.

{"id": "OTB.ExtractROI", "title": "Extract a ROI defined by the user.", "description": "This application extracts a Region Of Interest with user parameters. There are four mode of extraction. The standard mode allows the user to enter one point (upper left corner of the region to extract) and a size. The extent mode needs two points (upper left corner and lower right) and the radius mode need the center of the region and the radius : it will extract the rectangle containing the circle defined and limited by the image dimension. The fit mode needs a reference image or vector and the dimension of the extracted region will be the same as the extent of the reference. Different units are available such as pixel, image physical space or longitude and latitude.", "version": "1.0.0", "jobControlOptions": ["sync-execute", "async-execute", "dismiss"], "outputTransmission": ["value", "reference"], "links": [{"rel": "http://www.opengis.net/def/rel/ogc/1.0/execute", "type": "application/json", "title": "Execute End Point", "href": "http://tb17.geolabs.fr:8111/ogc-api/processes/OTB.ExtractROI/execution"}, {"rel": "alternate", "type": "text/html", "title": "Execute End Point", "href": "http://tb17.geolabs.fr:8111/ogc-api/processes/OTB.ExtractROI/execution.html"}], "inputs": {"in": {"title": "Image to be processed.", "description": "Image to be processed.", "extended-schema": {"oneOf": [{"allOf": [{"$ref": "http://zoo-project.org/dl/link.json"}, {"type": "object", "properties": {"type": {"enum": ["image/tiff", "image/jpeg", "image/png"]}}}]}, {"type": "object", "required": ["value"], "properties": {"value": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}}}]}, "schema": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}, "id": "in"}, "out": {"title": "Region of interest from the input image", "description": "Region of interest from the input image", "schema": {"type": "string", "default": "float", "enum": ["uint8", "uint16", "int16", "int32", "int32", "float", "double"]}, "id": "out"}, "mode": {"title": "mode", "description": "mode", "schema": {"type": "string", "default": "standard", "enum": ["standard", "fit", "extent", "radius"]}, "id": "mode"}, "mode.fit.im": {"title": "Reference image to define the ROI", "description": "Reference image to define the ROI", "extended-schema": {"oneOf": [{"allOf": [{"$ref": "http://zoo-project.org/dl/link.json"}, {"type": "object", "properties": {"type": {"enum": ["image/tiff", "image/jpeg", "image/png"]}}}]}, {"type": "object", "required": ["value"], "properties": {"value": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}}}]}, "schema": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}, "id": "mode.fit.im"}, "mode.fit.vect": {"title": "The extent of the input vector file is computed and then gives a region of interest that will be extracted.", "description": "The extent of the input vector file is computed and then gives a region of interest that will be extracted.", "extended-schema": {"oneOf": [{"allOf": [{"$ref": "http://zoo-project.org/dl/link.json"}, {"type": "object", "properties": {"type": {"enum": ["text/xml", "application/vnd.google-earth.kml+xml", "application/json", "application/zip"]}}}]}, {"type": "object", "required": ["value"], "properties": {"value": {"oneOf": [{"type": "string", "contentEncoding": "utf-8", "contentMediaType": "text/xml"}, {"type": "string", "contentEncoding": "utf-8", "contentMediaType": "application/vnd.google-earth.kml+xml"}, {"type": "object"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "application/zip"}]}}}]}, "schema": {"oneOf": [{"type": "string", "contentEncoding": "utf-8", "contentMediaType": "text/xml"}, {"type": "string", "contentEncoding": "utf-8", "contentMediaType": "application/vnd.google-earth.kml+xml"}, {"type": "object"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "application/zip"}]}, "id": "mode.fit.vect"}, "mode.extent.ulx": {"title": "X coordinate of upper left corner point.", "description": "X coordinate of upper left corner point.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.extent.ulx"}, "mode.extent.uly": {"title": "Y coordinate of upper left corner point.", "description": "Y coordinate of upper left corner point.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.extent.uly"}, "mode.extent.lrx": {"title": "X coordinate of lower right corner point.", "description": "X coordinate of lower right corner point.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.extent.lrx"}, "mode.extent.lry": {"title": "Y coordinate of lower right corner point.", "description": "Y coordinate of lower right corner point.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.extent.lry"}, "mode.extent.unit": {"title": "mode.extent.unit", "description": "mode.extent.unit", "schema": {"type": "string", "default": "pxl", "enum": ["pxl", "phy", "lonlat"]}, "id": "mode.extent.unit"}, "mode.radius.r": {"title": "This is the radius parameter of the radius mode.", "description": "This is the radius parameter of the radius mode.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.radius.r"}, "mode.radius.unitr": {"title": "mode.radius.unitr", "description": "mode.radius.unitr", "schema": {"type": "string", "default": "pxl", "enum": ["pxl", "phy"]}, "id": "mode.radius.unitr"}, "mode.radius.cx": {"title": "This is the center coordinate of the radius mode, it will be either an ordinate or a latitude.", "description": "This is the center coordinate of the radius mode, it will be either an ordinate or a latitude.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.radius.cx"}, "mode.radius.cy": {"title": "mode.radius.cy", "description": "mode.radius.cy", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "mode.radius.cy"}, "mode.radius.unitc": {"title": "mode.radius.unitc", "description": "mode.radius.unitc", "schema": {"type": "string", "default": "pxl", "enum": ["pxl", "phy", "lonlat"]}, "id": "mode.radius.unitc"}, "startx": {"title": "ROI start x position.", "description": "ROI start x position.", "schema": {"type": "integer", "default": 0}, "id": "startx"}, "starty": {"title": "ROI start y position.", "description": "ROI start y position.", "schema": {"type": "integer", "default": 0}, "id": "starty"}, "sizex": {"title": "size along x in pixels.", "description": "size along x in pixels.", "schema": {"type": "integer", "default": 0}, "id": "sizex"}, "sizey": {"title": "size along y in pixels.", "description": "size along y in pixels.", "schema": {"type": "integer", "default": 0}, "id": "sizey"}, "cl": {"title": "Channels to write in the output image.", "description": "Channels to write in the output image.", "maxOccurs": 1024, "schema": {"type": "string", "default": "Any value"}, "id": "cl"}, "elev.dem": {"title": "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.", "description": "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.", "schema": {"type": "string", "default": "Any value", "nullable": true}, "id": "elev.dem"}, "elev.geoid": {"title": "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(https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-data/blob/master/Input/DEM/egm96.grd).", "description": "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(https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb-data/blob/master/Input/DEM/egm96.grd).", "extended-schema": {"oneOf": [{"allOf": [{"$ref": "http://zoo-project.org/dl/link.json"}, {"type": "object", "properties": {"type": {"enum": ["application/octet-stream"]}}}]}, {"type": "object", "required": ["value"], "properties": {"value": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "application/octet-stream"}]}}}], "nullable": true}, "schema": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "application/octet-stream"}]}, "id": "elev.geoid"}, "elev.default": {"title": "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.", "description": "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.", "schema": {"type": "number", "default": 0, "format": "double"}, "id": "elev.default"}, "ram": {"title": "Available memory for processing (in MB)", "description": "Available memory for processing (in MB)", "schema": {"type": "integer", "default": 128, "nullable": true}, "id": "ram"}}, "outputs": {"out": {"title": "Region of interest from the input image", "description": "Region of interest from the input image", "extended-schema": {"oneOf": [{"allOf": [{"$ref": "http://zoo-project.org/dl/link.json"}, {"type": "object", "properties": {"type": {"enum": ["image/tiff", "image/jpeg", "image/png"]}}}]}, {"type": "object", "required": ["value"], "properties": {"value": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}}}]}, "schema": {"oneOf": [{"type": "string", "contentEncoding": "base64", "contentMediaType": "image/tiff"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/jpeg"}, {"type": "string", "contentEncoding": "base64", "contentMediaType": "image/png"}]}, "id": "out"}}}

http://tb17.geolabs.fr:8111/ogc-api/processes/OTB.ExtractROI.html
Last modified: Sat Dec 4 00:09:36 CET 2021