SUMMARY - Make summaries of HFRC objects. Usage: res = summary( hfrc_obj, sum_all, times, func_name, ... ) sum_all specifies whether or not to generate a summary of all variables or just U & V. times specifies a set of time breaks, between which summary information should be calculated. If empty or not given, it defaults to daily summaries between the beginning and the end of the time series, starting at midnight. This function takes special care to deal with bad data. In the process, bad data is changed to zeros. Currently func_name can be 'summary_num', 'summary_mean' and 'summary_sd' and 'summary_sd_mean' and 'summary_princ_axis'. It could also be any function that accepts arguments of the form: func_name( hfrc_obj, sum_all, ... ). The function must currently return a single argument. func_name defaults to 'summary_mean'. 'summary_sd_mean' is special. It returns the standard deviation of the velocity vectors around the mean velocity. hfrc_obj.U will be the deviation of the component of the velocity in the direction of the mean and hfrc_obj.V will be the deviation of the component of the velocity perpendicular to the mean. If sum_all is anything but 0, then this is just the same as 'summary_sd'. 'summary_princ_axis' is also special. It computes the principal axis for each chunk of data and returns a structure with three fields: 'angles', 'major_var' and 'minor_var'. If sum_all is anything other than 0, it returns an error. The mean time for each piece will be returned as matlab_time. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% $Id: summary.m,v 1.15 2006-12-18 15:20:19 dmk Exp $ Copyright (C) 2003 David M. Kaplan Licence: GPL (Gnu Public License) %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

- HFRC HFRC - This creates a HFRC object.
- angle ANGLE - Returns the angle of each current vectors with respect to
- end END - basic end method for HFRC objects.
- gooddata GOODDATA - returns a matrix of good data in object.
- isempty
- isnan ISNAN - returns position of any NaN data in either U or V.
- length LENGTH - returns number of times in HFRC object.
- matvars MATVARS
- mean MEAN - mean of a field in an HFRC object
- principal_axis PRINCIPAL_AXIS - Finds principal axis of each grid point.
- rotate ROTATE - rotates totals currents through an angle
- size SIZE - returns [ (num times), (num gridpts) ].
- subsasgn SUBSASGN Set HFRC variables easily.
- subsref SUBSREF Get HFRC elements easily
- vertcat Vertical concantenation of HFRC objects

Generated on Mon 18-Dec-2006 07:26:46 by