LTPDA Toolbox™

Method ssm/cpsd

  CPSD computes the output theoretical CPSD shape with given inputs.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: CPSD computes the output theoretical CPSD shape with given inputs.
               Unlike ssm/psd, it returns the total contribution and takes
               input vectors/square matrices of objects 
 
  CALL: [mat_out] = cpsd(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

Sets for this method …
Default

Default
no description
Key	Default Value	Options	Description
reorganize
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.
cpsd
COVARIANCE	[]	none	The covariance of this noise between input ports for the time-discrete noise model.
CPSD	[]	none	The one sided cross-psd of the white noise between input ports.
AOS	[]	none	An array of input AOs, The power spectrum of this noise between input ports for the time-continuous noise model.
PZMODELS	[]	none	An array of input pzmodels for noise filtering
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
F	[]	none	Specify a vector of frequencies. If this is used, 'f1', 'f2', and 'nf' parameters are ignored.

Example
plist('COVARIANCE VARIABLE NAMES', cell(0,0), 'CPSD VARIABLE NAMES', cell(0,0), 'PZMODEL VARIABLE NAMES', cell(0,0), 'AOS VARIABLE NAMES', cell(0,0), 'RETURN STATES', cell(0,0), 'RETURN OUTPUTS', cell(0,0), 'COVARIANCE', [[]], 'CPSD', [[]], 'AOS', [[]], 'PZMODELS', [[]], 'REORGANIZE', [true], 'F2', [[]], 'F1', [[]], 'NF', [200], 'F', [[]])

Some information of the method ssm/cpsd are listed below:
Class name	ssm
Method name	cpsd
Category	Operator
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	1
Supported numeric types	{'double'}

Method: ssm/assemble

Method: ssm/cpsdForCorrelatedInputs

Method ssm/cpsd

Parameter Description

Default

Example