>  Docs Center  >  ENVI API  >  Processing  >  ENVIExtractRasterFromFileTask

ENVIExtractRasterFromFileTask

ENVIExtractRasterFromFileTask

This task opens a single raster from an input uniform resource indicator (URI).

Syntax


Result = ENVITask('ExtractRasterFromFile')

Input properties (Set, Get): DATASET_INDEX, DATASET_NAME, DATA_IGNORE_VALUE, EXTERNAL_TYPE, INPUT_URI, TEMPLATE

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

TAGS

This task also contains the following properties:

DATASET_INDEX (optional)

This property applies to file formats with multiple rasters per file such as ECRG, HDF5, Landsat, Multi-page TIFF, NetCDF-4, NITF with multiple image segments, Proba-V, Sentinel, and SkySat-1. Set it to a zero-based index number of the raster to open.

DATASET_NAME (optional)

This property applies to file formats with multiple datasets per file. Set it to a string with the name of a raster dataset that you want to open within the file. Strings are case-sensitive. See the DATASET_NAME keyword description in the ENVI::OpenRaster topic for further guidelines.

DATA_IGNORE_VALUE (optional)

Set this keyword to a pixel value that will be ignored when the raster is displayed. This overrides any data ignore values set in the metadata.

EXTERNAL_TYPE (optional)

Use this keyword to open raster datasets in external file formats not natively supported by the ENVI::OpenRaster method.

acres
adrg
ads40
alos
arcview
atsr
avhrr
avhrr_sharp
bmp
cadrg
cib
cosmo-skymed
dmc
dmsp_noaa
eo1_hdf
ecw
envisat
eos_aster
eos_modis
er_mapper
erdas_lan
eros_l1a
eros_l1b
ers
formosat-2
irs_fast
irs_super_structured
jers
landsat_ceos
landsat_fast
landsat_hdf
landsat_mrlc
landsat_nlaps
master
pci
pds
pict
png
radarsat
seawifs
sicd
spot_cap_sisa
spot_geospot
spot_vegetation
srf
tims
topsar
usgs_doq
usgs_drg
usgs_native_dem
usgs_sdts_dem
xwd
srtm_dem

INPUT_URI (required)

Specify the input URI.

OUTPUT_RASTER

This is the raster extracted from the URI.

TEMPLATE

Set this keyword to a string with the name of a custom XML template used to open generic HDF4, generic HDF5, NetCDF-3, and NetCDF-4 datasets. Creating and restoring templates can be helpful when you want to build the same raster and metadata structure from several source files. See Work with Templates for instructions on creating templates. Save templates to the directory specified by the Custom Code Directory preference. If you set this keyword, you cannot also set the DATASET_NAME keyword.

Version History


ENVI 5.5

Introduced

API Version


3.3

See Also


ENVITask, ENVITask::Parameter, ENVI::OpenRaster



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