Method ssm/cpsdForCorrelatedInputs


  cpsdForCorrelatedInputs computes the output theoretical CPSD shape with given inputs.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: cpsdForCorrelatedInputs computes the output theoretical CPSD
               or PSD shape with given inputs.
               It returns summed and contributions only and takes
               input arrays of objects (instead of vectors) 
 
  CALL: [mat_out] = cpsdForCorrelatedInputs(sys, pl)
 
  INPUTS:
          - sys, (array of) ssm object
 
  OUTPUTS:
           _ mat_out contains specified returned aos
 
  Parameters Description
  
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ssm
Sealed 0
Static 0

Parameter Description

Default

no description
Key Default Value Options Description
COVARIANCE VARIABLE NAMES {} [0x0] none A cell-array of strings specifying the desired input variable names.
CPSD VARIABLE NAMES {} [0x0] none A cell-array of strings specifying the desired input variable names.
PZMODEL VARIABLE NAMES {} [0x0] none A cell-array of strings of the desired input variable names.
AOS VARIABLE NAMES {} [0x0] none A cell-array of input defined with AOs spectrums.
RETURN STATES {} [0x0] none A cell-array of names of state ports to return.
RETURN OUTPUTS, OUTPUTS {} [0x0] none A cell-array of output ports to return.
COVARIANCE [] none The covariance matrix of this noise between input ports for the time-discrete noise model.
CPSD [] none The one sided cpsd matrix of the white noise between input ports.
AOS empty AO object [1x0] none An array of input AOs, provides the cpsd of the input noise.
PZMODELS [] none An array of input pzmodels, used to filter the input noise.
REORGANIZE 1
  • 1
  • 0
When set to 0, this means the ssm does not need be modified to match the requested i/o. Faster but dangerous!
F2 [] none The maximum frequency. Default is Nyquist or 1Hz.
F1 [] none The minimum frequency. Default is f2*1e-5.
NF 200 none The number of frequency bins. Frequencies are scale logarithmically
DIAGONAL ONLY 1
  • 1
  • 0
Set to true if you want the PSD instead of the CPSD
F [] none Specify a vector of frequencies. If this is used, 'f1', 'f2', and 'nf' parameters are ignored.
back to top back to top

Some information of the method ssm/cpsdForCorrelatedInputs are listed below:
Class name ssm
Method name cpsdForCorrelatedInputs
Category Operator
Package name ltpda
VCS Version 8ab8cbbc4bccf7543491a24448f4aae0b1be1c43
Min input args 1
Max input args -1
Min output args 1
Max output args -1




©LTP Team