LTPDA Toolbox™ contents Method: ao/getKSCValPSD   Method: ao/heterodyne

Method ao/getdof

  GETDOF Calculates degrees of freedom for psd, lpsd, cohere and lcohere
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: GETDOF Input psd or mscohere (magnitude square coherence)
  estimated with the WOSA (Welch's Overlapped Segment Averaging Method) and
  return degrees of freedom of the estimator.
 
  CALL:         dof = getdof(a,pl)
 
  INPUTS:
                a  -  input analysis objects containing power spectral
                      densities or magnitude squared coherence.
                pl  - input parameter list
 
  OUTPUTS:
                dof - cdata AO with degrees of freedom for the
                      corresponding estimator. If the estimators are lpsd
                      or lcohere then dof number of elements is the same of
                      the spectral estimator
 
 
               If the last input argument is a parameter list (plist).
               The following parameters are recognised.
 
  
 
  Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ao
Sealed 0
Static 0

Parameter Description

Sets for this method …
Default

Default
no description
Key Default Value Options Description
getdof
METHOD 'psd'
  • 'psd'
  • 'lpsd'
  • 'mscohere'
  • 'mslcohere'
 Set the desired method. Supported values are
  • 'psd' power spectrum calculated with ao/psd, whatever the scale
  • 'lpsd' power spectrum calculated with ao/lpsd, whatever the scale
  • 'mscohere' magnitude square coherence spectrum calculated with ao/cohere
  • 'mslcohere' magnitude square coherence spectrum calculated with ao/lcohere
DATALENGTH [] none Data length of the time series.It is better to input for more stable calculation.Leave it empty if you do not know its value.

Example
plist('METHOD', 'psd', 'DATALENGTH', [[]])

back to top back to top

Some information of the method ao/getdof are listed below:
Class name ao
Method name getdof
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: ao/getKSCValPSD  Method: ao/getKSCValPSD   Method: ao/heterodyne Method: ao/heterodyne

©LTP Team