Welcome to the Harris Geospatial product documentation center. Here you will find reference guides, help documents, and product libraries.


Harris Geospatial / Docs Center / ENVI API / Processing / SubsetRaster

SubsetRaster

ENVISubsetRasterTask

This task subsets a raster spatially (by pixel coordinates) and/or spectrally.

Example


; Start the application
e = ENVI()
 
; Open an input file
File = Filepath('qb_boulder_msi', Subdir=['data'], $
  Root_Dir=e.Root_Dir)
Raster = e.OpenRaster(File)
 
; Define the subrect
subRect = [Raster.nSamples/4, Raster.nLines/4, $
  Raster.nSamples*3/4, Raster.nLines*3/4]
 
 
; Get the task from the catalog of ENVITasks
Task=ENVITask('SubsetRaster')
 
; Define inputs
Task.INPUT_RASTER = Raster
Task.Sub_Rect = subRect
 
; Define outputs
Task.OUTPUT_RASTER_URI = e.GetTemporaryFilename()
 
; Run the task
Task.Execute
 
; Get the collection of data objects currently available in the Data Manager
DataColl = e.Data
 
; Add the output to the Data Manager
DataColl.Add, Task.Output_Raster
 
; Display the result
View1 = e.GetView()
Layer1 = View1.CreateLayer(Task.Output_Raster)

Syntax


Result = ENVITask('SubsetRaster')

Input properties (Set, Get): BANDS, IGNORE_VALIDATE, INPUT_RASTER, OUTPUT_RASTER_URI, SUB_RECT

Output properties (Get only): DESCRIPTION, NAME, OUTPUT_RASTER

Properties marked as "Set" are those that you can set to specific values. You can also retrieve their current values any time. Properties marked as "Get" are those whose values you can retrieve but not set.

Methods


This task inherits the following methods from ENVITask:

AddParameter

Execute

Parameter

ParameterNames

RemoveParameter

Properties


BANDS (optional)

Specify an array of band indices to include in the OUTPUT_RASTER. The indices are zero-based, and a scalar is allowed for single-band output.

DESCRIPTION

This property describes the task.

IGNORE_VALIDATE (optional)

This property is now deprecated and has no effect on task behavior. All task property values are validated when they are set, and they throw an error with bad input.

INPUT_RASTER (required)

Specify the input ENVIRaster to subset.

NAME

This property contains the name of the task.

OUTPUT_RASTER

This is a reference to the output raster of filetype ENVI.

OUTPUT_RASTER_URI (optional)

Specify a string with the fully qualified filename and path of the output raster. If you do not specify this property, the output raster is only temporary. Once the raster has no remaining references, ENVI deletes the temporary file.

SUB_RECT (optional)

Set this keyword to a four-element array expressing the spatial range of the raster data, in pixel coordinates. The array is of the form:

[columnMin, rowMin, columnMax, rowMax]

Version History


ENVI 5.2, Service Pack 1

Introduced

API Version


3.1.0

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIGeographicSubsetRasterTask



© 2017 Exelis Visual Information Solutions, Inc. |  Legal
My Account    |    Buy    |    Contact Us