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

amats

A matrix representing a difference/differential term 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

timestep

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

ssm

inputs

ssmblock for input blocks

ssm

states

ssmblock describing state blocks

ssm

outputs

ssmblock describing the output blocks

ssm

numparams

nested plist describing the numeric (substituted) parameters

ssm

params

nested plist describing the symbolic parameters

ssm

hist

history of the object (history object)

ltpda_uoh

procinfo

plist with additional information for an object.

ltpda_uoh

plotinfo

plist with the plot information

ltpda_uoh

name

name of the object

ltpda_uo

description

description of the object

ltpda_uo

mdlfile

model xml file of the LTPDAworkbench

ltpda_uo

UUID

Universally Unique Identifier of 128-bit

ltpda_uo

Back to Top Back to Top

Methods

Constructor Constructor of this class
Converter Convertor methods
Helper Helper methods only for internal usage
Internal Internal methods only for internal usage
Operator Operator methods
Output Output methods
Relational Operator Relational operator methods
Signal Processing Signal processing 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

Converter

Methods Description Defined in class

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

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

created

CREATED Returns a time object of the last modification.

ltpda_uoh

creator

CREATOR Extract the creator(s) from the history.

ltpda_uoh

csvexport

CSVEXPORT Exports the data of an object to a csv file.

ltpda_uoh

index

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

ltpda_uoh

requirements

REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.

ltpda_uoh

setDescription

SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.

ltpda_uoh

setMdlfile

SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.

ltpda_uoh

setName

SETNAME Sets the property 'name' of an ltpda_uoh object.

ltpda_uoh

setPlotinfo

SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.

ltpda_uoh

setProcinfo

SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.

ltpda_uoh

addParameters

ADDPARAMETERS Adds the parameters to the model.

ssm

duplicateInput

DUPLICATEINPUT copies the specified input blocks.

ssm

parameterDiff

PARAMETERDIFF Makes a ssm that produces the output and state derivatives.

ssm

setBlockDescriptions

SETBLOCKDESCRIPTIONS Sets descriptions of the specified SSM blocks.

ssm

setBlockNames

SETBLOCKNAMES Sets names of the specified SSM blocks.

ssm

setBlockProperties

SETBLOCKPROPERTIES Sets the specified properties of the specified SSM blocks.

ssm

setParameters

SETPARAMETERS Sets the values of the given parameters.

ssm

setParams

SETPARAMS Sets the parameters of the model to the given plist.

ssm

setPortDescriptions

SETPORTDESCRIPTIONS Sets descriptions of the specified SSM ports.

ssm

setPortNames

SETPORTNAMES Sets names of the specified SSM ports.

ssm

setPortProperties

SETPORTPROPERTIES Sets names of the specified SSM ports.

ssm

setPortUnits

SETPORTUNITS Sets units of the specified SSM ports.

ssm

Back to Top of Section Back to Top of Section

Internal

Methods Description Defined in class

isprop

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

ltpda_obj

bsubmit

BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository

ltpda_uo

submit

SUBMIT Submits the given objects to an LTPDA repository

ltpda_uo

update

UPDATE Updates the given object in an LTPDA repository

ltpda_uo

string

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

ltpda_uoh

type

TYPE converts the input objects to MATLAB functions.

ltpda_uoh

generateConstructorPlist

GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.

ssm

ssm2dot

SSM2DOT converts a statespace model object a DOT file.

ssm

Back to Top of Section Back to Top of Section

Operator

Methods Description Defined in class

CPSD

CPSD computes the output theoretical CPSD shape with given inputs.

ssm

PSD

PSD computes the output theoretical CPSD shape with given inputs.

ssm

append

appends embedded subsytems, with exogenous inputs

ssm

assemble

assembles embedded subsytems, with exogenous inputs

ssm

cpsdForCorrelatedInputs

cpsdForCorrelatedInputs computes the output theoretical CPSD shape with given inputs.

ssm

cpsdForIndependentInputs

CPSDFORINDEPENDENTINPUTS computes the output theoretical CPSD shape with given inputs.

ssm

kalman

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

ssm

keepParameters

KEEPPARAMETERS enables to substitute symbollic patameters

ssm

modifyTimeStep

MODIFYTIMESTEP modifies the timestep of a ssm object

ssm

optimiseForFitting

OPTIMISEFORFITTING reduces the system matrices to doubles and strings.

ssm

reorganize

REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD.

ssm

sMinReal

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

ssm

simplify

SIMPLIFY enables to do model simplification

ssm

simulate

SIMULATE simulates a discrete ssm with given inputs

ssm

steadyState

STEADYSTATE returns a possible value for the steady state of an ssm.

ssm

subsParameters

SUBSPARAMETERS enables to substitute symbolic patameters

ssm

Back to Top of Section Back to Top of Section

Output

Methods Description Defined in class

save

SAVE overloads save operator for ltpda objects.

ltpda_uo

report

REPORT generates an HTML report about the input objects.

ltpda_uoh

viewHistory

VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.

ltpda_uoh

char

CHAR convert a ssm object into a string.

ssm

display

DISPLAY display ssm object.

ssm

displayProperties

DISPAYPROPERTIES displays the ssm model porperties.

ssm

dotview

DOTVIEW view an ssm object via the DOT interpreter.

ssm

double

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

ssm

findParameters

findParameters returns parameter names matching the given pattern.

ssm

getParameters

getParameters returns parameter values for the given names.

ssm

getParams

GETPARAMS returns the parameter list for this SSM model.

ssm

isStable

ISSTABLE tells if ssm is numerically stable

ssm

settlingTime

SETTLINGTIME retunrns 1% the settling time of the system.

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

Signal Processing

Methods Description Defined in class

bode

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

ssm

bodecst

BODECST makes a bodecst plot from the given inputs to outputs.

ssm

generateCovariance

GENERATECOVARIANCE generates a default covarance matrix.

ssm

resp

RESP gives the timewise impulse response of a statespace model.

ssm

respcst

RESPCST gives the timewise impulse response of a statespace model.

ssm

Back to Top of Section Back to Top of Section




©LTP Team