Home > Applications > Horace > @d4d > head.m

iFit/head

PURPOSE ^

Display a summary of a d4d object or file containing d4d information.

SYNOPSIS ^

function varargout = head (varargin)

DESCRIPTION ^

 Display a summary of a d4d object or file containing d4d information.
 
   >> head(w)              % Summary for object (or array of objects)
   >> head(d4d,filename)   % Summary for named file (or array of names)

 To return header information in a structure, without displaying to screen:

   >> h=head(...)          % Fetch principal header information


 The facility to get head information from file(s) is included for completeness, but
 more usually you would use the function:
   >> head_horace(filename)
   >> h=head_horace(filename)


 Input:
 -----
   w           d4d object or array of d4d objects
       *OR*
   d4d         Dummy d4d object to enforce the execution of this method.
               Can simply create a dummy object with a call to d4d:
                   e.g. >> w = head(d4d,'c:\temp\my_file.d4d')

   file        File name, or cell array of file names. In latter case, displays
               summary for each sqw object

 Output (optional):
 ------------------
   h           Structure with header information, or cell array of structures if
               given a cell array of file names.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 26-Nov-2018 15:08:42 by m2html © 2005. iFit (c) E.Farhi/ILL EUPL 1.1