>  Docs Center  >  Libraries  >  CATALYST  >  HDF_SD_VARINFO

HDF_SD_VARINFO

HDF_SD_VARINFO

Name


    HDF_SD_VARINFO

Purpose


    Return information about a Scientific Data Set (SDS) variable
    in a HDF file.

Category


    HDF utilities.

Calling Sequence


    RESULT = HDF_SD_VARINFO(HDFID, VARNAME)

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


    None.

Outputs


    An anonymous structure containing information about the SDS.
    The fields in the structure are as follows:
    NAME Name of the variable ('' if variable not found)
    NDIMS Number of dimensions (-1 if variable not found)
    DIMS Array of dimension sizes (-1 if variable not found)
    DIMNAMES Array of dimension names ('' if variable not found)
    TYPE Variable data type ('' if variable not found)

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)
result = hdf_sd_varinfo(hdfid, '2D integer array')
hdf_sd_end, hdfid
help, result, /structure

Modification History


  Liam.Gumley@ssec.wisc.edu
  http://cimss.ssec.wisc.edu/~gumley
  $Id: hdf_sd_varinfo.pro,v 1.2 1999/12/29 21:22:30 gumley Exp $
  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.



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