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

polyval

PURPOSE ^

POLYVAL - HFRC method for polyval function

SYNOPSIS ^

function [ht, hdt] = polyval( h, varargin )

DESCRIPTION ^

 POLYVAL - HFRC method for polyval function

 Usage: [hfrc_trend, hfrc_detrended] = polyval( hfrc, p, s, mu )
        [vname_trend,vname_detrend ] = polyval( hfrc, vname, p, s, mu )

 In the first form, HFRC objects will be returned with only the trend
 and with the trend removed from U and V.  In this case, p, s, and mu
 must be structures of the form returned by HFRC/polyfit.

 In the second form, the trend and remainder of a single variable will
 be returned.  vname should be a string and p, s and mu should be
 matrices of the form returned by HFRC/polyfit.

 This function ignores bad data.  It is a good way to remove unwanted
 trends.

 In all cases, the s and mu input arguments are optional.


 Example of linear detrending:

 [hfrc_trend, hfrc_detrend] = polyval( hfrc, polyfit( hfrc, 1 ) );

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

     $Id: polyval.m,v 1.3 2003-04-02 00:56:07 dmk Exp $    

 Copyright (C) 2002 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