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


  >  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, INPUT_RASTER, OUTPUT_RASTER_URI, SUB_RECT

Output properties (Get only): 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


This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

COMMUTE_ON_SUBSET

DESCRIPTION

DISPLAY_NAME

NAME

REVISION

This task also contains the following 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.

INPUT_RASTER (required)

Specify the input ENVIRaster to subset.

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 to export the associated OUTPUT_RASTER.

  • If you set this property to an asterisk symbol (*), the output raster will be virtual and not written to disk.
  • If you do not specify this property, or set it to an exclamation symbol (!), a temporary file will be created.

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

ENVI 5.5

OUTPUT_RASTER_URI now supports '*', which allows OUTPUT_RASTER to be virtual output.

API Version


3.2

See Also


ENVITask, ENVITask::Parameter, ENVISubsetRaster, ENVIGeographicSubsetRasterTask



© 2018 Harris Geospatial Solutions, Inc. |  Legal
My Account    |    Store    |    Contact Us