Documentation for "mat2vsfid"

PURPOSE ^

MAT2VSFID write Matlab structure array as an HDF4 vdata, to an open HDF4 file I

SYNOPSIS ^

function vdata_id = mat2vsfid(file_id, vname, vstru, vattr, vclass)

DESCRIPTION ^

MAT2VSFID   write Matlab structure array as an HDF4 vdata, to an open HDF4 file I

 NAME

   mat2vsfid  - write a matlab structure to an HDF VS

 SYNOPSIS

   vdata_id = mat2vsfid(file_id, vname, vstru, vattr, vclass) 

 INPUTS

   file_id   - HDF file ID from hopen
   vname     - name for the new vdata
   vstru     - structure of arrays, the main data
   vattr     - cell array of attributes, optional
   vclass    - vdata class, char string, optional

 OUTPUT

   vdata_id  - the vdata ID, after a detach

 INPUT DATA FORMATS

   The input vstru is a structure whose fields are fsize-by-nrec
   arrays.  fsize is the field size and nrec the number of records;
   nrec should be the same for all fields.

   The input vattr is a cell list of attribute specifications.
   Each attribute specification is a list of three strings, of 
   the form
                      {fname, aname, aval}
   
   where fname is either a field name or for general attributes the
   vdata name, aname is the attribute name, and aval the attribute
   value.
        
 NOTES

   vstru is a structure of arrays rather than an array of
   structures, because manipulating the former is much faster
   in Matlab, for large arrays; see stransp1.m and stransp2.m 
   to go between the two formats.


 H. Motteler, 9 July 01

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Wed 05-Jan-2011 21:42:04 by m2html using template 3frames © Guillaume Flandin, Lorenz Gerstmayr, 2003-2005