Differences

This shows you the differences between two versions of the page.

Link to this comparison view

reference:ft_specest_mtmconvol [2018/08/23 14:43] (current)
Line 1: Line 1:
 +=====  FT_SPECEST_MTMCONVOL =====
 +
 +Note that this reference documentation is identical to the help that is displayed in MATLAB when you type "help ft_specest_mtmconvol"​.
 +
 +<​html><​pre>​
 +  <a href=/​reference/​ft_specest_mtmconvol><​font color=green>​FT_SPECEST_MTMCONVOL</​font></​a>​ performs wavelet convolution in the time domain by
 +  multiplication in the frequency domain.
 + 
 +  Use as
 +    [spectrum,​ntaper,​freqoi,​timeoi] = ft_specest_mtmconvol(dat,​time,​...)
 +  where input
 +    dat       = matrix of chan*sample
 +    time      = vector, containing time in seconds for each sample
 +  and output
 +    spectrum ​ = matrix of ntaper*chan*freqoi*timeoi of fourier coefficients
 +    ntaper ​   = vector containing the number of tapers per freqoi
 +    freqoi ​   = vector of frequencies in spectrum
 +    timeoi ​   = vector of timebins in spectrum
 + 
 +  Optional arguments should be specified in key-value pairs and can include
 +    taper     = '​dpss',​ '​hanning'​ or many others, see WINDOW (default = '​dpss'​)
 +    pad       = number, indicating time-length of data to be padded out to in seconds
 +    padtype ​  = string, indicating type of padding to be used (see ft_preproc_padding,​ default: zero)
 +    timeoi ​   = vector, containing time points of interest (in seconds)
 +    timwin ​   = vector, containing length of time windows (in seconds)
 +    freqoi ​   = vector, containing frequencies (in Hz)
 +    tapsmofrq = number, the amount of spectral smoothing through multi-tapering. Note: 4 Hz smoothing means plus-minus 4 Hz, i.e. a 8 Hz smoothing box
 +    dimord ​   = '​tap_chan_freq_time'​ (default) or '​chan_time_freqtap'​ for memory efficiency
 +    verbose ​  = output progress to console (0 or 1, default 1)
 +    taperopt ​ = additional taper options to be used in the WINDOW function, see WINDOW
 +    polyorder = number, the order of the polynomial to fitted to and removed from the data prior to the fourier transform (default = 0 -&gt; remove DC-component)
 + 
 +  See also <a href=/​reference/​ft_freqanalysis><​font color=green>​FT_FREQANALYSIS</​font></​a>,​ <a href=/​reference/​ft_specest_mtmfft><​font color=green>​FT_SPECEST_MTMFFT</​font></​a>,​ <a href=/​reference/​ft_specest_tfr><​font color=green>​FT_SPECEST_TFR</​font></​a>,​ <a href=/​reference/​ft_specest_hilbert><​font color=green>​FT_SPECEST_HILBERT</​font></​a>,​ <a href=/​reference/​ft_specest_wavelet><​font color=green>​FT_SPECEST_WAVELET</​font></​a>​
 +</​pre></​html>​