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

mean

PURPOSE ^

MEAN - mean of a field in an HFRC object

SYNOPSIS ^

function [U, V] = mean( h, varargin )

DESCRIPTION ^

 MEAN - mean of a field in an HFRC object

 Usage: [U_mean, V_mean] = mean( hfrc_obj, DIM )
              field_mean = mean( hfrc_obj, fieldname, DIM )

 This function returns the mean of a field of an HFRC object.  DIM is as
 described in the normal mean function - dimension over which to perform
 mean (1=time, 2=space).  fieldname is a string with the name of
 the field to perform the mean over.

 If DIM is not given, it defaults to 1 (time).
 
 NOTE: This function does NOT take into account bad values.

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

     $Id: mean.m,v 1.6 2006-12-05 18:09:51 dmk Exp $    

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

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

CROSS-REFERENCE INFORMATION ^

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