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

summary

PURPOSE ^

SUMMARY - Make summaries of HFRC objects.

SYNOPSIS ^

function hh = summary( h, sum_all, tt, fn, varargin )

DESCRIPTION ^

 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)

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

CROSS-REFERENCE INFORMATION ^

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