ExtractRasterFromFile Task

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:

Properties

This task inherits the following properties from ENVITask:

COMMUTE_ON_DOWNSAMPLE

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 property 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 property to open raster datasets in external file formats not natively supported by the ENVI::OpenRaster method.

File Type String	Description
acres	Australian Centre for Remote Sensing (ACRES) Canadian Centre for Remote Sensing (CCRS) Landsat and SPOT data
ads40	Airborne Digital Sensor developed by Leica Geosystems
alos	Advanced Land Observing Satellite
arcview	ArcView raster format files that have the `.bil` file extension and an associated header file with the `.hdr` extension. ENVI extracts the header information, including the UTM and State Plane projection georeferencing information.
atsr	Gridded Brightness Temperature (GBT), Gridded Browse (GBROWSE), and Gridded SST (GSST) data from ATSR-1 and ATSR-2
avhrr	Advanced Very High Resolution Radiometer (AVHRR)
avhrr_sharp	European Space Agency SHARP data
cadrg	Compressed ARC Digitized Raster Graphics (CADRG) format
cib	Controlled Image Base (CIB) format
cosmo-skymed	COSMO-SkyMed radar format
dmc	ENVI reads and displays data from the UK-DMCSat-1, ALSAT-1, and NigeriaSat-1 satellites that are part of the DMC (Disaster Monitoring Constellation).
dmsp_noaa	NOAA Defense Meteorological Satellite Program (DMSP) Operational Linescan System (OLS) format
ecw	Enhanced Compressed Wavelet
envisat	Environmental Satellite (Envisat)
eo1_hdf	EO-1 ALI or Hyperion data in HDF format
eos_aster	Earth Observing System (EOS) Advanced Spaceborne Thermal Emission and Reflection Radiometer (ASTER) data
eos_modis	EOS Moderate Resolution Imaging Spectroradiometer (MODIS) data
er_mapper	ER mapper format
erdas_lan	ERDAS file (*.lan)
eros_l1a	Earth Resources Observation System 1A data
eros_l1b	ImageSat International EROS A Level 1B files
ers	European Remote Sensing Satellite-1 or -2
formosat-2	FORMOSAT-2 DIMAP (.dim) data
irs_fast	Indian Remote Sensing (IRS) data in Earth Observation Satellite Company (EOSAT) Fast format
irs_super_structured	IRS Super Structured data
jers	Japanese Earth Resources Satellite
landsat_ceos	European Space Agency CEOS Landsat TM data
landsat_fast	Landsat TM data in EOSAT Fast format
landsat_hdf	Landsat data in Hierarchical Data Format (HDF)
landsat_mrlc	Multi-Resolution Land Characteristic format for Landsat TM and DEM data
landsat_nlaps	National Landsat Archive Production System (NLAPS) format for Landsat TM and MSS data
master	MODIS/ASTER Simulator (MASTER) MAS-50 HDF data
pci	PCI Geomatics format (`.pix`)
pds	Planetary Data System format
pict	QuickDraw Picture
png	Portable Network Graphics
radarsat	Canadian Radar Satellite data
seawifs	SeaWiFS data
spot_cap_sisa	SPOT 1A, 2A, and 1B data
spot_geospot	Reads the primary format for SPOT data. ArcView raster image files have a similar format specification. The GeoSPOT format is described in detail in documentation available from SPOT Image.
spot_vegetation	SPOT vegetation data
srtm_dem	Shuttle Radar Topography Mission Digital Elevation Model data
srf	Spectral Response Function. Engineering data that quantify the spectral response and sensitivity of detectors on an airborne or satellite sensor. The term SRF also refers to a data format that contains SRF data for particular sensors.
tims	Thermal Infrared Multispectral Scanner data
topsar	Raw AIRSAR Integrated Processor Data format (Cvv, incidence angle, correlation image, or DEM)
usgs_doq	USGS Digital Orthophoto Quadrangle data
usgs_drg	USGS Digital Raster Graphic data
usgs_native_dem	USGS Digital Elevation Model data
usgs_sdts_dem	USGS Spatial Data Transfer Standard
xwd	X Window Dump

INPUT_URI (required)

Specify the input URI.

OUTPUT_RASTER

This is the raster extracted from the URI.

TEMPLATE

Set this property 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 property, you cannot also set the DATASET_NAME property.

Version History

ENVI 5.5	Introduced
ENVI 5.7	Deprecated `sicd` as an EXTERNAL_TYPE file type string. SICD support has been added to ENVI.

API Version

4.2