ssm Class


Properties Properties of the class
Methods All Methods of the class ordered by category.
Examples Some constructor examples

Back to Class descriptions Back to Class descriptions

Properties

The LTPDA toolbox restrict access of the properties.

The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).

For example:

val = obj.prop(2).prop;
The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
For example:
obj2 = obj1.setName('my name') % This command creates a copy of obj1 (obj1 ~= obj2)
obj.setName('my name');        % This command applies to obj    

Properties Description Defined in class

description

Description string

ssm

amats

A matrix representing a difference/differential term in the state equation, block stored in a cell array

ssm

mmats

M matrix representing an inertial coefficient matrix in the state equation, block stored in a cell array

ssm

bmats

B matrix representing an input coefficient matrix in the state equation, block stored in a cell array

ssm

cmats

C matrix representing the state projection in the observation equation, block stored in a cell array

ssm

dmats

D matrix representing the direct feed through term in the observation equation, block stored in a cell array

ssm

isnumerical

This binary tells whether the system has numerical content only, or symbolic as well

ssm

timestep

Timestep of the difference equation. Zero means the representation is time continuous and A defines a differential equation.

ssm

nonlin

ssm

inputnames

Names corresponding to each input column-block in the B/D matrices. Cell array of strings

ssm

inputvarnames

Names corresponding to each input column in each column-block of the B/D matrices. Cell array of cell array of Strings

ssm

inputsizes

Width corresponding to each input column-block in the B/D matrices. It is a double vector

ssm

inputconn

ssm

Ninputs

Number of input column-blocks, it is a double

ssm

ssnames

Names corresponding to each input state-block in the A/B/C matrices. Cell array of strings

ssm

ssvarnames

Names corresponding to each variable in each input state-block in the A/B/C matrices. Cell array of cell array of Strings

ssm

sssizes

Size corresponding to each input state-block in the A/B/C matrices. It is a double vector

ssm

ssconn

ssm

Nss

Number of state-blocks, it is a double

ssm

outputnames

Names corresponding to each output row-block in the C/D matrices. Cell array of strings

ssm

outputvarnames

Names corresponding to each output variable in each row-block in the C/D matrices. Cell array of cell array of Strings

ssm

outputsizes

Width corresponding to each output row-block in the C/D matrix. It is a double vector

ssm

outputconn

ssm

Noutputs

Number of output row-blocks, it is a double

ssm

paramnames

Names of each parameter, stored as a string in a cell array

ssm

paramvalues

Nominal value of each parameter, stored as a double vector

ssm

paramsigmas

Expected variance of each parameter, stored as a double vector

ssm

Nparams

Total number of parameters

ssm

version

CVS version string of the constructor

ssm

hist

History object associated with this object

ltpda_uoh

name

Name of the object

ltpda_uo

Back to Top Back to Top

Methods

Constructor Constructor of this class
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Output Output methods
Relational Operator Relational operator methods

Back to Top Back to Top

Constructor

Methods Description Defined in class

rebuild

REBUILD rebuilds the input objects using the history.

ltpda_uoh

ssm

SSM statespace model class constructor.

ssm

Back to Top of Section Back to Top of Section

Helper

Methods Description Defined in class

get

GET get a property of a object.

ltpda_obj

isprop

ISPROP tests if the given field is one of the object properties.

ltpda_obj

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

index

INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.

ltpda_uoh

setName

SETNAME Set the property 'name'.

ltpda_uoh

setProperties

SETPROPERTIES set different properties of an object.

ltpda_uoh

string

STRING writes a command string that can be used to recreate the input object(s).

ltpda_uoh

findParams

FINDPARAMS returns parameter names matching the given pattern.

ssm

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

bsubmit

BSUBMIT bsubmits the given collection of objects to an LTPDA Repository.

ltpda_uo

submit

SUBMIT submits the given collection of objects to an LTPDA Repository.

ltpda_uo

update

UPDATE updates the given object in an LTPDA Repository.

ltpda_uo

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

save

SAVE overloads save operator for ltpda objects.

ltpda_uoh

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

char

CHAR convert a ssm object into a string.

ssm

display

DISPLAY display ssm object.

ssm

dotview

DOTVIEW view an ssm object via the DOT interpreter.

ssm

isstable

tells if ssm is numerically stable

ssm

Back to Top of Section Back to Top of Section

Relational Operator

Methods Description Defined in class

eq

EQ overloads the == operator for ltpda objects.

ltpda_obj

ne

NE overloads the ~= operator for ltpda objects.

ltpda_obj

Back to Top of Section Back to Top of Section

Statespace

Methods Description Defined in class

assemble

assembles embedded subsytems, with exogenous inputs

ssm

bode

BODE makes a bode plot from the given inputs to outputs.

ssm

copy

COPY Make copy of ssm objects depending of the second input

ssm

double

Convert a statespace model object to double arrays for given i/o

ssm

getParamValues

GETPARAMVALUES returns parameter values for the given names.

ssm

kalman

kalman applies Kalman filtering to a discrete ssm with given i/o

ssm

minreal

minreal gives a minimal realization of a ssm object by deleting unreached states

ssm

modifparams

modifparams enables to modifyy and substitute parameters

ssm

modiftimestep

modiftime modifies the timestep of a ssm object

ssm

modify

modify allows to exectue a string to modify a ssm object

ssm

reduce

reduce enables to do model simplification

ssm

reduce_model

REDUCE_MODEL enables to do model simplification

ssm

resp

resp gives the timewise impulse response of a ssm

ssm

setparams

SETPARAMS enables to set parameters' value

ssm

simulate

simulate simulates a discrete ssm with given inputs

ssm

simulate2

simulate2 is the Old and slower version of simulate

ssm

ssm2dot

SSM2DOT converts a statespace model object a DOT file.

ssm

ssm2iirpz

ssm2iirpz converts a statespace model object to an miir or a pzmodel

ssm

ssm2miir

ssm2miir converts a statespace model object to a miir object

ssm

ssm2pzmodel

ssm2pzmodel converts a time-continuous statespace model object to a pzmodel

ssm

ssm2rational

ssm2rational converts a statespace model object to a rational frac. object

ssm

ssm2ss

SSM2SS converts a statespace model object to a MATLAB statespace object.

ssm

subsparams

subsparams enables to substitute symbollic patameters

ssm

Back to Top of Section Back to Top of Section




©LTP Team