Method ssm/kalman


  KALMAN applies kalman filtering to a discrete ssm with given i/o
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
  DESCRIPTION: KALMAN applies kalman filtering to a discrete ssm with
               given i/o.
  CALL: [mat_out pl_out] = kalman(sys, plist_inputs)
 
  INPUTS:
          - sys, (array of) ssm object
 
  OUTPUTS:
           _ mat_out contains specified returned aos
           _ pl_out contains 'lastX', the last state position
 
  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.
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.
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 empty AO object [1x0] none An array of input AOs (experimental stimuli).
CONSTANTS [] none Array of DC values for the different corresponding inputs.
KNOWN OUTPUTS empty AO object [1x0] none Array of AOs for the different corresponding outputs (experiment measurements).
NSAMPLES Inf none The maximum number of samples to simulate (AO length(s) overide this).
SSINI {} [0x0] none A cell-array of vectors that give the initial position for simulation.
TINI 0 none The initial filtering time (seconds).
DISPLAYTIME 1
  • 1
  • 0
Switch off/on the display
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!
FORCE COMPLETE 0
  • 0
  • 1
Force the use of the complete simulation code.
back to top back to top

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




©LTP Team