>  Docs Center  >  Libraries  >  CATALYST  >  HDF_SD_VARREAD
Libraries

HDF_SD_VARREAD

HDF_SD_VARREAD

Name


    HDF_SD_VARREAD

Purpose


    Read data from a Scientific Data Set (SDS) variable
    in a HDF file.

Category


    HDF utilities.

Calling Sequence


    HDF_SD_VARREAD, HDFID, VARNAME, DATA

Inputs


    HDFID Identifier of HDF file opened by caller with HDF_SD_START.
    VARNAME Name of Scientific Data Set variable.

Optional Inputs


    None.

Keyword Parameters


    START Set this keyword to a vector containing the start position
                for the read in each dimension
                (default start position is [0, 0, ..., 0]).
    COUNT Set this keyword to a vector containing the number of items
                to be read in each dimension
                (default is to read all available data).
    STRIDE Set this keyword to a vector containing the sampling interval
                along each dimension
                (default stride vector for a contiguous read is [0, 0, ..., 0]).
    NOREVERSE Set the keyword to retrieve the data without transposing the
                data from column to row order.

Outputs


    DATA Named variable in which data will be returned
                (degenerate dimensions are removed).

Optional Outputs


    None

Common Blocks


    None

Side Effects


    None.

Restrictions


    Requires IDL 5.0 or higher (square bracket array syntax).

Example



file = 'sdsvdata.hdf'
hdfid = hdf_sd_start(file)
hdf_sd_varread, hdfid, '2D integer array', data
hdf_sd_end, hdfid
help, data

Modification History


  Liam.Gumley@ssec.wisc.edu
  http://cimss.ssec.wisc.edu/~gumley
  Copyright (C) 1999, 2000 Liam E. Gumley
  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 2
  of the License, or (at your option) any later version.
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.
  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.



© 2024 NV5 Geospatial Solutions, Inc. |  Legal
   Contact Us