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

filtfiltT

PURPOSE ^

FILTFILTT - Temporal filtering of radar data.

SYNOPSIS ^

function [a,b] = filtfiltT( varargin )

DESCRIPTION ^

 FILTFILTT - Temporal filtering of radar data.

 NOTE: Use of this function is DEPRECATED.  It is currently just a link to
 filterT with name_filter_function='filtfilt' (assuming an alternate is
 not given).  

 This function filters HFRC object data using the matlab filter function on
 the temporal dimension - ie. it filters in time, ignoring the space
 dimension.

 Usage: [ hfrc_obj, matlab_time ] = filtfiltT( hfrc_obj, filter_all, B, A, ... )
        [ hfrc_var, matlab_time ] = filtfiltT( hfrc_obj, name_hfrc_var, B, A, ... )
        [ hfrc_obj, frequency ] = filtfiltT( hfrc_obj, filter_all, B, A, ... )
        [ hfrc_var, frequency ] = filtfiltT( hfrc_obj, name_hfrc_var, B, A, ... )

 where filter_all is a boolean that expresses whether or not to filter
 all variables that have a temporal component (such as U_error).
 The default is filter_all==0, in which case only U and V are filtered.

 name_hfrc_var is the string name of a single HFRC variable
 (U,V,U_error,etc.) that you wish to be put through the filter and
 returned.  In this case, the HFRC object is neither returned nor altered.

 B and A are best explained in the filter command help.

 ... represents arguments to be passed directly to filtfilt.  See filtfilt for
 more details.

 If a second output argument is given, matlab_time or frequency, depending
 on the temporal_domain of hfrc_obj, is also put through the same filtfilt
 and returned separately.

 NOTE: Matlab requires that matrices be full to use filtfilt, so fullHFRC
 is applied before filtering.

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

     $Id: filtfiltT.m,v 1.14 2003-05-27 19:27: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