Home > hfrc > matlab > @HFRC > EOF.m

EOF

PURPOSE ^

EOF - computes EOF on a field of an HFRC object.

SYNOPSIS ^

function [L, EOFs, EC, error, norms, data] = EOF( h, fn, varargin )

DESCRIPTION ^

 EOF - computes EOF on a field of an HFRC object.

 Usage: [L, EOFs, EC, error, norms, data] = EOF( hfrc_obj, fieldname, ... )

 fieldname is a string with the name of the field to perform the EOF on.
 It can also be 'complex', in which case this function performs EOF
 analysis on U+iV.  Finally, it can be 'double', in which case the
 Time-Modulation form of the Global PCA is performed, following
 Preisendorfer & Mobley (1988, pg. 167-172).

 ... are extra arguments to be given to EOF function found in the
 utility directory.  See the help for that function for more details.

 If only the hfrc_obj is given, fieldname = 'double'.

 The mean is removed from each data point before performing the EOF
 analysis.  Other kinds of detrending must be performed separately using
 HFRC/detrend or HFRC/polyfit.

 L are the eigenvalues of the covariance matrix ( ie. they are normalized
 by 1/(m-1), where m is the number of rows ).  EC are the expansion
 coefficients (PCs in other terminology) and error is the the
 reconstruction error (L2-norm).  data is the matrix that was input into
 utility/EOF.m

 This function depends on utility/EOF.m

 NOTE: This function assumes all your data is good.  Interpolate
 beforehand or remove bad data otherwise.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

     $Id: EOF.m,v 1.9 2005-01-18 23:34:31 dmk Exp $    

 Copyright (C) 2001 David M. Kaplan
 Licence: GPL (Gnu Public License)

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Mon 18-Dec-2006 07:26:46 by m2html © 2003