SubsetRaster Task
This task subsets a raster spatially (by pixel coordinates) and/or spectrally.
The virtual raster associated with this task is ENVISubsetRaster.
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
; 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
View = e.GetView()
Layer = View.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:
Properties
This task inherits the following properties from ENVITask:
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 property 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. 1 |
Introduced |
|
ENVI 5.5 |
OUTPUT_RASTER_URI now supports '*', which allows OUTPUT_RASTER to be virtual output. |
API Version
4.2