LTPDA Toolbox™ contents Method: matrix/consolidate   Method: matrix/crb

Method matrix/cpsd

  CPSD estimates the cross-spectral density between elements of the vector.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: CPSD estimates the cross-spectral density between the
               elements of the vector input. The elements are expected to
               be time-series AOs, otherwise an error will occur.
 
  The input should be a vector of time-series AOs of length N. CPSD will
  then compute all cross-spectral densities between the elements of the
  vector, resulting in a symmetric matrix of size NxN. 
  
  NOTE: the lower diagonal elements are not computed; they are just copies
  of the upper diagonal elements.
  
  
  CALL:        mo = cpsd(mi, pl)
 
  INPUTS:      mi   - input matrix object of size Nx1 (or 1xN)
               pl   - input parameter list
 
  OUTPUTS:     mo   - output matrix object of size NxN
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class matrix
Sealed 0
Static 0

Parameter Description

Sets for this method …
Default

Default
no description
Key Default Value Options Description
cpsd
NFFT -1 none The number of samples in each fft [default: length of input data].
A string value containing the variable 'fs' can also be used, e.g.,
plist('Nfft', '2*fs')
WIN 'BH92'
  • 'Rectangular'
  • 'Welch'
  • 'Bartlett'
  • 'Hanning'
  • 'Hamming'
  • 'Nuttall3'
  • 'Nuttall4'
  • 'Nuttall3a'
  • 'Nuttall3b'
  • 'Nuttall4a'
  • 'Nuttall4b'
  • 'Nuttall4c'
  • 'BH92'
  • 'SFT3F'
  • 'SFT3M'
  • 'FTNI'
  • 'SFT4F'
  • 'SFT5F'
  • 'SFT4M'
  • 'FTHP'
  • 'HFT70'
  • 'FTSRS'
  • 'SFT5M'
  • 'HFT90D'
  • 'HFT95'
  • 'HFT116D'
  • 'HFT144D'
  • 'HFT169D'
  • 'HFT196D'
  • 'HFT223D'
  • 'HFT248D'
  • 'Kaiser'
  • 'levelledHanning'
 The window to be applied to the data to remove the discontinuities at edges of segments. [default: taken from user prefs]
Only the design parameters of the window object are used. Enter a string value containing the window name e.g.
plist('Win', 'Kaiser', 'psll', 200)
plist('Win', 'BH92')
PSLL 200 none The peak sidelobe level for Kaiser windows.
Note: it is ignored for all other windows
OLAP -1 none The segment percent overlap [-1 == take from window function]
ORDER, N 0
  • -1
  • 0
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
 The order of segment detrending:
  • -1 - no detrending
  • 0 - subtract mean
  • 1 - subtract linear fit
  • N - subtract fit of polynomial, order N
NAVS -1 none Force number of averages. If set, and if Nfft was set to 0 or -1,
the number of points for each window will be calculated to match the request.
DROP WINDOW SAMPLES 1
  • 1
  • 0
 Drop the recommended (by the window) number of samples of the final computed spectral series.
TIMES, SPLIT [] none The time range to analyze. If not empty, sets the time interval to operate on.
As in ao/split, the interval can be specified by:
  • a vector of doubles
  • a timespan object
  • a cell array of time strings
  • a vector of time objects

Example
plist('NFFT', [-1], 'WIN', 'BH92', 'PSLL', [200], 'OLAP', [-1], 'ORDER', [0], 'NAVS', [-1], 'DROP WINDOW SAMPLES', [true], 'TIMES', [[]])

back to top back to top

Some information of the method matrix/cpsd are listed below:
Class name matrix
Method name cpsd
Category Signal Processing
Package name ltpda
VCS Version 967b0eec0dece803a81af8ef54ad2f8c784b20b2
Min input args 1
Max input args -1
Min output args 1
Max output args -1
Can be used as modifier 0
Supported numeric types {'double'}



Method: matrix/consolidate  Method: matrix/consolidate   Method: matrix/crb Method: matrix/crb

©LTP Team