Home > Libraries > Loaders > read_idl.m

iFit/read_idl

PURPOSE ^

READ_IDL: restores variable from an IDL save file into Matlab

SYNOPSIS ^

function outargs=read_idl(varargin)

DESCRIPTION ^

 READ_IDL:  restores variable from an IDL save file into Matlab
 variables.

   s=read_idl(filename)

 Input arguments (can appear in any order, and all are optional):

   - filename: complete path specification for the save file
   - 'lowercase': convert variable names from ALL CAPS to all lowercase
   - 'verbose': print out analysis of file structure
   - 'restore_verbose': print out lots of stuff while restoring variables
   - 'debug': both verbose and restore_verbose

 This version restores every variable it knows how to do, and puts them
 all into the output argument array or a struct whose field names are the
 IDL variable names, and field values are the IDL variables themselves.
 The latter (single structure) method is the default.
 
 To create a MATLAB variable from one of the fields in the single 
 structure, do this:
   fields=fieldnames(outargs);
   eval([fields{n} '=outargs.' fields{n} ';']);


 Output is a struct array with fields "name" and "value", where
 "name" is the name of the variable, and "value" is a cell array
 containing the variable, whatever it may be.  Could be a scalar, numeric
 array, string, struct, array of structs, nested structs, what have you.

 References:
 restore_idl by Charles Pelizzari, 2013
   used in iLoad/read_idl, BSD
   <http://jp.mathworks.com/matlabcentral/fileexchange/43899-restore-idl>

 See also: read_tdms, read_lvm, read_igor, read_fig

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Tue 22-Aug-2017 11:03:30 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1