LTPDA Toolbox™ contents Method: ssm/removeEmptyBlocks   Method: ssm/sMinReal

Method ssm/reorganize

  REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: rearranges a ssm object for fast input to BODE, SIMULATE, PSD.
 
  CALL:    sys = reshuffle(sys, plist)
 
  INPUTS:
          'sys'      - ssm object
          'plist'    - plist object
 
   The inputs/states/outputs can only be indexed using a cellstr containing
   block names or port names.
   Then the object can be passed to BODE, SIMULATE, PSD, CPSD, RESP with
   the option "rearrange" turned to "false". These functions will run
   significantly faster.
 
  OUTPUTS:
 
         'sys' - a ssm object.
 
   Parameters Description
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Method Details
Access public
Defining Class ssm
Sealed 0
Static 0

Parameter Description

Sets for this method …
For bode
For simulate
For kalman
For cpsd
For resp
For psd
for cpsdforindependentinputs
for cpsdforcorrelatedinputs

For bode
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
INPUTS 'ALL' none A cell-array of input ports and blocks.
OUTPUTS 'ALL' none A cell-array of output ports and blocks.
STATES 'NONE' none A cell-array of states ports and blocks.

Example
plist('SET', 'for cpsdforindependentinputs', 'INPUTS', 'ALL', 'OUTPUTS', 'ALL', 'STATES', 'NONE')

back to top back to top

For simulate
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
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.
AOS VARIABLE NAMES, AO NAMES, AO PORT NAMES {} [0x0] none A cell-array of input port names corresponding to the different input AOs.
CONSTANT VARIABLE NAMES {} [0x0] none A cell-array of strings of the desired input variable names.
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.

Example
plist('SET', 'for cpsdforindependentinputs', 'COVARIANCE VARIABLE NAMES', cell(0,0), 'CPSD VARIABLE NAMES', cell(0,0), 'AOS VARIABLE NAMES', cell(0,0), 'CONSTANT VARIABLE NAMES', cell(0,0), 'RETURN STATES', cell(0,0), 'RETURN OUTPUTS', cell(0,0))

back to top back to top

For kalman
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
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.
AOS VARIABLE NAMES, AO NAMES, AO PORT NAMES {} [0x0] none A cell-array of input port names corresponding to the different input AOs.
CONSTANT VARIABLE NAMES {} [0x0] none A cell-array of strings of the desired input variable names.
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.
KNOWN OUTPUT VARIABLE NAMES {} [0x0] none A cell-array of strings of the known output variable names.

Example
plist('SET', 'for cpsdforindependentinputs', 'COVARIANCE VARIABLE NAMES', cell(0,0), 'CPSD VARIABLE NAMES', cell(0,0), 'AOS VARIABLE NAMES', cell(0,0), 'CONSTANT VARIABLE NAMES', cell(0,0), 'RETURN STATES', cell(0,0), 'RETURN OUTPUTS', cell(0,0), 'KNOWN OUTPUT VARIABLE NAMES', cell(0,0))

back to top back to top

For cpsd
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
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.

Example
plist('SET', 'for cpsdforindependentinputs', '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))

back to top back to top

For resp
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
INPUTS 'ALL' none A cell-array of input ports and blocks.
OUTPUTS 'ALL' none A cell-array of output ports and blocks.
STATES 'NONE' none A cell-array of states ports and blocks.

Example
plist('SET', 'for cpsdforindependentinputs', 'INPUTS', 'ALL', 'OUTPUTS', 'ALL', 'STATES', 'NONE')

back to top back to top

For psd
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
VARIANCE VARIABLE NAMES {} [0x0] none A cell-array of strings specifying the desired input variable names.
PSD 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.

Example
plist('SET', 'for cpsdforindependentinputs', 'VARIANCE VARIABLE NAMES', cell(0,0), 'PSD 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))

back to top back to top

for cpsdforindependentinputs
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
VARIANCE VARIABLE NAMES {} [0x0] none A cell-array of strings specifying the desired input variable names.
PSD 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.

Example
plist('SET', 'for cpsdforindependentinputs', 'VARIANCE VARIABLE NAMES', cell(0,0), 'PSD 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))

back to top back to top

for cpsdforcorrelatedinputs
no description
Key Default Value Options Description
reorganize
SET 'for cpsdforindependentinputs'
  • 'For bode'
  • 'For simulate'
  • 'For kalman'
  • 'For cpsd'
  • 'For resp'
  • 'For psd'
  • 'for cpsdforindependentinputs'
  • 'for cpsdforcorrelatedinputs'
 Choose for which operation the ssm iois re-organized is done
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.

Example
plist('SET', 'for cpsdforindependentinputs', '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))

back to top back to top

Some information of the method ssm/reorganize are listed below:
Class name ssm
Method name reorganize
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/removeEmptyBlocks  Method: ssm/removeEmptyBlocks   Method: ssm/sMinReal Method: ssm/sMinReal

©LTP Team