Is an array of compression parameters. Status is -1 and other

outputs are [] if the operation fails.

SWinqswath

[NSWATH,SWATHLIST] = HDFSW('inqswath',FILENAME)

Retrieves number and names of swaths defined in HDF-EOS file.

FILENAME is a string containing the file name. NSWATH is the number

of swath data sets found in the file. SWATHLIST is a string

containing a comma-separated list of swath names. If the routine

fails, NSWATH is -1 and SWATHLIST is [].

SWregionindex

[REGIONID, GEODIM, IDXRANGE] = HDFSW('regionindex',...

SWATHID, CORNERLON, CORNERLAT, MODE);

Defines a longitude-latitude box region for a swath. The

difference between this routine and SWdefboxregion is the

geolocation track dimension name and the range of that dimension

are returned in addition to a regionID. See the help for

SWdefboxregion for a description of valid inputs.

SWupdateidxmap

[INDEXOUT, INDICES, IDXSZ] = HDFSW('updateidxmap',SWATHID,...

REGIONID,INDEXIN);

Retrieves an indexed array of specified geolocation mapping for a

specified region. REGIONID is the swath region identifier.

INDEXIN is the array containing the indices of the data dimension

to which each geolocation element corresponds. INDEXOUT is an

array containing the indices of the data dimension to which each

geolocation corresponds in the subsetted region. INDICES is an

array containing the indices for the start and stop of the region.

IDXSZ is the size of the INDICES array or -1 for failure.

SWgeomapinfo

REGMAP = HDFSW('geomapinfo',SWATHID, GEODIM)

Retrieves type of dimension mapping for the dimension with the

name GEODIM. The return value REGMAP will be: 0 for no mapping 1

for regular mapping, 2 for indexed mapping, 3 for both regular and

indexed, or -1 for failure.

Subset Functions

----------------

SWdefboxregion

REGIONID = HDFSW('defboxregion',SWATH_ID,CORNERLON,...

CORNERLAT,MODE)

Defines a longitude-latitude box region for a swath. CORNERLON and

CORNERLAT are two-element arrays containing the longitude and

latitude in decimal degrees of the box corners. MODE is the cross

track inclusion mode, and can be 'HDFE_MIDPOINT', 'HDFE_ENDPOINT',

or 'HDFE_ANYPOINT'. REGIONID is the swath region identifier if the

routine succeeds or -1 if it fails.

SWregioninfo

[NTYPE,RANK,DIMS,SIZE,STATUS] = HDFSW('regioninfo',...

SWATH_ID,REGIONID,FIELDNAME)

Retrieves information about the subsetted region. REGIONID is the

swath region identifier. FIELDNAME is a string containing the name

of the field to subset. NTYPE is a string containing the HDF

number type of the field. RANK is the RANK of the field. DIMS is

an array giving the dimensions of the subset region. SIZE is the

size in bytes of the subset region.

SWextractregion

[DATA,STATUS] = HDFSW('extractregion',SWATH_ID,...

REGIONID,FIELDNAME,EXTERNAL_MODE)

Extracts (reads) from subsetted region. REGIONID is the swath

region identifier. FIELDNAME is a string containing the name of

the field to subset. EXTERNAL_MODE is a string containing the

external geolocation mode, which can be 'external' (data and

geolocation fields can be in different swaths), or 'internal' (data

and geolocation fields must be in the same swath structure). DATA

is the data contained in the subsetted region.

SWdeftimeperiod

PERIODID = HDFSW('deftimeperiod',SWATH_ID,STARTTIME,...

STOPTIME,MODE)

Defines a time period for a swath. STARTTIME and STOPTIME are the

start and stop time of the period. MODE is the Cross Track

inclusion mode, and can be 'midpoint', 'endpoint', or 'anypoint'.

PERIODID is the time period identifier. If the routine fails,

PERIODID is -1.

SWperiodinfo

[NTYPE,RANK,DIMS,SIZE,STATUS] = HDFSW('periodinfo',...

SWATH_ID,PERIODID,FIELDNAME)

Retrieves information about the subsetted period. PERIODID is the

period identifier, and FIELDNAME is a string containing the name of

the field to subset. NTYPE is a string containing the HDF number

type of the field. RANK is the rank of the field. DIMS is an

array containing the dimensions of the subsetted period. SIZE is

the size in bytes of the subset period. STATUS is -1 and other

outputs are [] if the operation fails.

SWextractperiod

[DATA,STATUS] = HDFSW('extractperiod',SWATH_ID,...

PERIODID,FIELDNAME,EXTERNAL_MODE)

Extracts (reads) from subsetted time period. PERIODID is the

period identifier. FIELDNAME is a string containing the name of

the field to subset. EXTERNAL_MODE is the external geolocation

mode, which can be 'external' (data and geolocation fields can be

in different swaths), or 'internal' (data and geolocation fields

must be in the same swath structure). DATA is the data contained

in the subsetted time period.

SWdefvrtregion

ID2 = HDFSW('defvrtregion',SWATH_ID,ID,VERTOBJ,RANGE)

Subsets on a monotonic field or contiguous elements of a dimension.

ID is the region or period identifier from a previous subset call,

or -1 if this is the first call. VERTOBJ is a string containing the

name of the dimension or field to subset by. RANGE is a two

element vector containing the range to subset on. ID2 is the new

region or period identifier if the routine succeeds, or -1 if it

fails.

SWdupregion

ID2 = HDFSW('dupregion',ID)

Duplicates a region or period. ID is the region or period

identifier. ID2 is the new region or period identifier. If the

routine fails, ID2 is -1.

Please read the file hdf4copyright.txt for more information.

See also hdf, hdfpt, hdfgd.