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

detrend

PURPOSE ^

DETREND - detrend an HFRC object

SYNOPSIS ^

function h = detrend( h, varargin )

DESCRIPTION ^

 DETREND - detrend an HFRC object

 Usage: hfrc_obj2 = detrend( hfrc_obj, ... )

 This function removes the trend from the components of the total
 currents contained in the HFRC object.  Each column of U and V
 (ie. each time series) has its trend removed.

 ... represent extra arguments passed to the detrend function.  See the
 help for the normal detrend function for more information.  You probably
 want to pass this function at least 'constant' so that it just removes a
 mean.

 NOTE that this function is best for data with no holes -
 i.e. interpolated data, like one would have before performing a fft or
 EOF.  For more robust detrending with missing data, see polyfit.

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

     $Id: detrend.m,v 1.3 2002-12-20 21:21:46 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