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

fft

PURPOSE ^

FFT - fft transforms a HFRC object

SYNOPSIS ^

function h = fft( h, all, varargin )

DESCRIPTION ^

 FFT - fft transforms a HFRC object

 Usage: res = fft( hfrc_obj, fft_all, ... )

 res will depend on fft_all.  If fft_all is 0, then only U and V will be
 fft transformed and an HFRC object will be returned with
 temporal_domain='frequencyUV'.  If fft_all is 1, then all relevant
 variables in hfrc_obj will be fft transformed and an HFRC object will
 be returned with temporal_domain='frequencyALL'.

 If fft_all is a string, then the string will be treated as the name of
 a variable in hfrc_obj and the Fourier transform of that variable will
 be returned.

 ... are other arguments to be passed to fft directly.

 fft is much quicker if the number of elements in the series is a
 multiple of 2.  I suggest dropping the last element before applying fft
 if this is not the case.

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

     $Id: fft.m,v 1.8 2003-04-02 00:56:07 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