Categories of the Class SSM

Constructor Summary of all constructor methods
Converter Summary of all converter methods
Helper Summary of all helper methods
Internal Summary of all internal methods only for internal usage
Operator Summary of all operator methods
Output Summary of all output methods
Relational Operator Summary of all relational operator methods
Signal Processing Summary of all signal processing methods
Static Summary of all static methods

Constructor

rebuild Rebuilds the input objects using the history.
ssm Statespace model class constructor.

Back to Top Back to Top

Converter

ssm2miir Converts a statespace model object to a miir object
ssm2pzmodel Converts a time-continuous statespace model object to a pzmodel
ssm2rational Converts a statespace model object to a rational frac. object
ssm2ss Converts a statespace model object to a MATLAB statespace object.

Back to Top Back to Top

Helper

addParameters Adds the parameters to the model.
created Returns a time object of the last modification.
creator Extract the creator(s) from the history.
csvexport Exports the data of an object to a csv file.
duplicateInput Copies the specified input blocks.
get Get a property of a object.
index Index into a 'ltpda_uoh' object array or matrix. This properly captures the history.
parameterDiff Makes a ssm that produces the output and state derivatives.
plot Plots the user object on a figure.
requirements Returns a list of LTPDA extension requirements for a given object.
search Select objects that match the given name.
setBlockProperties Sets the specified properties of the specified SSM blocks.
setDescription Sets the 'description' property of a ltpda_uoh object.
setName Sets the property 'name' of an ltpda_uoh object.
setParameters Sets the values of the given parameters.
setParams Sets the parameters of the model to the given plist.
setPlotAxes Sets the 'axes' property of a the object's plotinfo.
setPlotColor Sets the color of a the object's plotinfo.
setPlotFigure Sets the 'figure' property of a the object's plotinfo.
setPlotFillmarker Defines if the plot function fill the marker or not.
setPlotLineStyle Sets the linestyle of a the object's plotinfo.
setPlotLinewidth Sets the linewidth of a the object's plotinfo.
setPlotMarker Sets the marker of a the object's plotinfo.
setPlotMarkerEdgeColor Sets the color of a the object's marker edge.
setPlotMarkerFaceColor Sets the color of a the object's marker face.
setPlotMarkersize Sets the markersize of a the object's plotinfo.
setPlotinfo Sets the 'plotinfo' property of a ltpda_uoh object.
setPlottingStyle Sets the style property of a the object's plotinfo.
setPortProperties Sets names of the specified SSM ports.
setProcinfo Sets the 'procinfo' property of a ltpda_uoh object.
setShowsErrors Sets the 'showErrors' property of a the object's plotinfo.

Back to Top Back to Top

Internal

bsubmit Submits the given collection of objects in binary form to an LTPDA repository
generateConstructorPlist Generates a PLIST from the properties which can rebuild the object.
isprop Tests if the given field is one of the object properties.
ssm2dot Converts a statespace model object a DOT file.
string Writes a command string that can be used to recreate the input object(s).
submit Submits the given collection of objects to an LTPDA repository
type Converts the input objects to MATLAB functions.
update Updates the given object in an LTPDA repository

Back to Top Back to Top

Operator

append Appends embedded subsytems, with exogenous inputs
assemble Assembles embedded subsytems, with exogenous inputs
cpsd Computes the output theoretical CPSD shape with given inputs.
cpsdForCorrelatedInputs Computes the output theoretical CPSD shape with given inputs.
cpsdForIndependentInputs Computes the output theoretical CPSD shape with given inputs.
kalman Applies Kalman filtering to a discrete ssm with given i/o
keepParameters Enables to substitute symbollic patameters
modifyTimeStep Modifies the timestep of a ssm object
optimiseForFitting Reduces the system matrices to doubles and strings.
psd Computes the output theoretical PSD shape with given inputs.
removeEmptyBlocks Enables to do model simplification
reorganize REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD.
sMinReal Gives a minimal realization of a ssm object by deleting unreached states
simplify Enables to do model simplification
simulate Simulates a discrete ssm with given inputs
steadyState Returns a possible value for the steady state of an ssm.
subsParameters Enables to substitute symbolic patameters

Back to Top Back to Top

Output

char Convert a ssm object into a string.
display Display ssm object.
displayProperties DISPAYPROPERTIES displays the ssm model porperties.
dotview View an ssm object via the DOT interpreter.
double Convert a statespace model object to double arrays for given i/o
findParameters Returns parameter names matching the given pattern.
getParameters Returns parameter values for the given names.
getParams Returns the parameter list for this SSM model.
getPortNamesForBlocks Returns a list of port names for the given block.
isStable Tells if ssm is numerically stable
report Generates an HTML report about the input objects.
save Overloads save operator for ltpda objects.
settlingTime Retunrns 1% the settling time of the system.
viewHistory Displays the history of an object as a dot-view or a MATLAB figure.

Back to Top Back to Top

Relational Operator

isequal Overloads the isequal operator for ltpda objects.

Back to Top Back to Top

Signal Processing

bode Makes a bode plot from the given inputs to outputs.
bodecst Makes a bodecst plot from the given inputs to outputs.
loglikelihood LOGLIKELIHOOD: Compute log-likelihood for SSM objects
projectNoise Performs actions on ao objects.
resp Gives the timewise impulse response of a statespace model.
respcst Gives the timewise impulse response of a statespace model.
viewDetails Performs actions on ssm objects.

Back to Top Back to Top

Static

SETS (No help available)
getBuiltInModels (No help available)
getDefaultPlist (No help available)
getInfo (No help available)
initObjectWithSize (No help available)
retrieve Retrieves a collection of objects from an LTPDA repository.

Back to Top Back to Top


©LTP Team