| LTPDA Toolbox™ | contents | |
|
Back to Class descriptions
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:The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method.
val = obj.prop(2).prop;
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 | Defining 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 | plotinfo object | ltpda_uoh |
| name | name of the object | ltpda_uo |
| description | description of the object | ltpda_uo |
| UUID | Universally Unique Identifier of 128-bit | ltpda_uo |
Back to Top
|
Back to Top
| Methods | Description | Defining Class |
|---|---|---|
| rebuild | Rebuilds the input objects using the history. | ltpda_uoh |
| ssm | Statespace model class constructor. | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| ssm2miir | Converts a statespace model object to a miir object | ssm |
| ssm2pzmodel | Converts a time-continuous statespace model object to a pzmodel | ssm |
| ssm2rational | Converts a statespace model object to a rational frac. object | ssm |
| ssm2ss | Converts a statespace model object to a MATLAB statespace object. | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| get | Get a property of a object. | ltpda_obj |
| search | Select objects that match the given name. | ltpda_uo |
| setDescription | Sets the 'description' property of a ltpda_uo object. | ltpda_uo |
| setName | Sets the property 'name' of an ltpda_uoh object. | ltpda_uo |
| created | Returns a time object of the last modification. | ltpda_uoh |
| creator | Extract the creator(s) from the history. | ltpda_uoh |
| csvexport | Exports the data of an object to a csv file. | ltpda_uoh |
| index | Index into a 'ltpda_uoh' object array or matrix. This properly captures the history. | ltpda_uoh |
| plot | Plots the user object on a figure. | ltpda_uoh |
| requirements | Returns a list of LTPDA extension requirements for a given object. | ltpda_uoh |
| setPlotAxes | Sets the 'axes' property of a the object's plotinfo. | ltpda_uoh |
| setPlotColor | Sets the color of a the object's plotinfo. | ltpda_uoh |
| setPlotFigure | Sets the 'figure' property of a the object's plotinfo. | ltpda_uoh |
| setPlotFillmarker | Defines if the plot function fill the marker or not. | ltpda_uoh |
| setPlotLineStyle | Sets the linestyle of a the object's plotinfo. | ltpda_uoh |
| setPlotLinewidth | Sets the linewidth of a the object's plotinfo. | ltpda_uoh |
| setPlotMarker | Sets the marker of a the object's plotinfo. | ltpda_uoh |
| setPlotMarkerEdgeColor | Sets the color of a the object's marker edge. | ltpda_uoh |
| setPlotMarkerFaceColor | Sets the color of a the object's marker face. | ltpda_uoh |
| setPlotMarkersize | Sets the markersize of a the object's plotinfo. | ltpda_uoh |
| setPlotinfo | Sets the 'plotinfo' property of a ltpda_uoh object. | ltpda_uoh |
| setPlottingStyle | Sets the style property of a the object's plotinfo. | ltpda_uoh |
| setProcinfo | Sets the 'procinfo' property of a ltpda_uoh object. | ltpda_uoh |
| setShowsErrors | Sets the 'showErrors' property of a the object's plotinfo. | ltpda_uoh |
| addParameters | Adds the parameters to the model. | ssm |
| duplicateInput | Copies the specified input blocks. | ssm |
| parameterDiff | Makes a ssm that produces the output and state derivatives. | ssm |
| setBlockProperties | Sets the specified properties of the specified SSM blocks. | ssm |
| setParameters | Sets the values of the given parameters. | ssm |
| setParams | Sets the parameters of the model to the given plist. | ssm |
| setPortProperties | Sets names of the specified SSM ports. | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| isprop | Tests if the given field is one of the object properties. | ltpda_obj |
| bsubmit | Submits the given collection of objects in binary form to an LTPDA repository | ltpda_uo |
| submit | Submits the given collection of objects to an LTPDA repository | ltpda_uo |
| update | Updates the given object in an LTPDA repository | ltpda_uo |
| string | Writes a command string that can be used to recreate the input object(s). | ltpda_uoh |
| type | Converts the input objects to MATLAB functions. | ltpda_uoh |
| generateConstructorPlist | Generates a PLIST from the properties which can rebuild the object. | ssm |
| ssm2dot | Converts a statespace model object a DOT file. | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| append | S embedded subsytems, with exogenous inputs | ssm |
| assemble | S embedded subsytems, with exogenous inputs | ssm |
| cpsd | Computes the output theoretical CPSD shape with given inputs. | ssm |
| cpsdForCorrelatedInputs | Computes the output theoretical CPSD shape with given inputs. | ssm |
| cpsdForIndependentInputs | Computes the output theoretical CPSD shape with given inputs. | ssm |
| kalman | Applies Kalman filtering to a discrete ssm with given i/o | ssm |
| keepParameters | Enables to substitute symbollic patameters | ssm |
| modifyTimeStep | Modifies the timestep of a ssm object | ssm |
| optimiseForFitting | Reduces the system matrices to doubles and strings. | ssm |
| psd | Computes the output theoretical PSD shape with given inputs. | ssm |
| removeEmptyBlocks | Enables to do model simplification | ssm |
| reorganize | REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD. | ssm |
| sMinReal | Gives a minimal realization of a ssm object by deleting unreached states | ssm |
| simplify | Enables to do model simplification | ssm |
| simulate | Simulates a discrete ssm with given inputs | ssm |
| steadyState | Returns a possible value for the steady state of an ssm. | ssm |
| subsParameters | Enables to substitute symbolic patameters | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| save | Overloads save operator for ltpda objects. | ltpda_uo |
| report | Generates an HTML report about the input objects. | ltpda_uoh |
| viewHistory | Displays the history of an object as a dot-view or a MATLAB figure. | ltpda_uoh |
| char | Convert a ssm object into a string. | ssm |
| display | Display ssm object. | ssm |
| displayProperties | DISPAYPROPERTIES displays the ssm model porperties. | ssm |
| 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 | Returns parameter names matching the given pattern. | ssm |
| getParameters | Returns parameter values for the given names. | ssm |
| getParams | Returns the parameter list for this SSM model. | ssm |
| getPortNamesForBlocks | Returns a list of port names for the given block. | ssm |
| isStable | Tells if ssm is numerically stable | ssm |
| settlingTime | Retunrns 1% the settling time of the system. | ssm |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| isequal | Overloads the isequal operator for ltpda objects. | ltpda_obj |
Back to Top of Section
| Methods | Description | Defining Class |
|---|---|---|
| bode | Makes a bode plot from the given inputs to outputs. | ssm |
| bodecst | Makes a bodecst plot from the given inputs to outputs. | ssm |
| c2d | Performs actions on ao objects. | ssm |
| d2c | Performs actions on ao objects. | ssm |
| d2d | Performs actions on ao objects. | ssm |
| loglikelihood | Compute log-likelihood for SSM objects | ssm |
| projectNoise | Performs actions on ao objects. | ssm |
| resp | Gives the timewise impulse response of a statespace model. | ssm |
| respcst | Gives the timewise impulse response of a statespace model. | ssm |
| viewDetails | Performs actions on ssm objects. | ssm |
Back to Top of Section
| |
smodel Class | timespan Class | |
©LTP Team