Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/class_desc_ssm.html @ 0:f0afece42f48
Import.
| author | Daniele Nicolodi <nicolodi@science.unitn.it> |
|---|---|
| date | Wed, 23 Nov 2011 19:22:13 +0100 |
| parents | |
| children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m-toolbox/html_help/help/ug/class_desc_ssm.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,1523 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd"> + +<html lang="en"> +<head> + <meta name="generator" content= + "HTML Tidy for Mac OS X (vers 1st December 2004), see www.w3.org"> + <meta http-equiv="Content-Type" content= + "text/html; charset=us-ascii"> + + <title>ssm Class (LTPDA Toolbox)</title> + <link rel="stylesheet" href="docstyle.css" type="text/css"> + <meta name="generator" content="DocBook XSL Stylesheets V1.52.2"> + <meta name="description" content= + "Presents an overview of the features, system requirements, and starting the toolbox."> + </head> + +<body> + <a name="top_of_page" id="top_of_page"></a> + + <p style="font-size:1px;"> </p> + + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr> + <td valign="baseline"><b>LTPDA Toolbox</b></td><td><a href="../helptoc.html">contents</a></td> + + <td valign="baseline" align="right"><a href= + "class_desc_smodel.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="smodel Class"></a> <a href= + "class_desc_timespan.html"><img src="b_next.gif" border="0" align= + "bottom" alt="timespan Class"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>ssm Class</h1> + <hr> + + <p> + + <!-- ================================================== --> + <!-- BEGIN CONTENT FILE --> + <!-- ================================================== --> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="categorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#top_properties">Properties</a> + </td> + <td>Properties of the class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#top_methods">Methods</a> + </td> + <td>All Methods of the class ordered by category.</td> + </tr> + <tr valign="top"> + <td> + <a href="constructor_examples_ssm.html">Examples</a> + </td> + <td>Some constructor examples</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Back to Class descriptions ===== --> + <a href="class_desc_main.html"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Class descriptions"/> + Back to Class descriptions + </a> + + <h2 class="title"><a name="top_properties"/>Properties</h2> + <p> + The LTPDA toolbox restrict access of the properties.<br></br> + The get access is 'public' and thus it is possible to get the values with the dot-command (similar to structures).<br></br> + <pre class="programlisting">For example:<br></br>val = obj.prop(2).prop;</pre> + The set access is 'protected' and thus it is only possible to assign a value to a property with a set-method. + <pre class="programlisting"> +For example: +obj2 = obj1.setName(<span class="string">'my name'</span>) <span class="comment">% This command creates a copy of obj1 (obj1 ~= obj2)</span> +obj.setName(<span class="string">'my name'</span>); <span class="comment">% This command applies to obj</span> </pre> + </p> + <!-- ===== Properties ===== --> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Properties</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- Property: 'amats' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.amats')">amats</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>A matrix representing a difference/differential term in the state equation, block stored in a cell array</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'bmats' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.bmats')">bmats</a></p> + </td> + <td> + <p>B matrix representing an input coefficient matrix in the state equation, block stored in a cell array</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'cmats' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.cmats')">cmats</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>C matrix representing the state projection in the observation equation, block stored in a cell array</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'dmats' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.dmats')">dmats</a></p> + </td> + <td> + <p>D matrix representing the direct feed through term in the observation equation, block stored in a cell array</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'timestep' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.timestep')">timestep</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>Timestep of the difference equation. Zero means the representation is time continuous and A defines a differential equation.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'inputs' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.inputs')">inputs</a></p> + </td> + <td> + <p>ssmblock for input blocks</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'states' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.states')">states</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssmblock describing state blocks</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'outputs' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.outputs')">outputs</a></p> + </td> + <td> + <p>ssmblock describing the output blocks</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'numparams' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.numparams')">numparams</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>nested plist describing the numeric (substituted) parameters</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'params' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.params')">params</a></p> + </td> + <td> + <p>nested plist describing the symbolic parameters</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- Property: 'hist' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.hist')">hist</a></p> + </td> + <td> + <p>history of the object (history object)</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'procinfo' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.procinfo')">procinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>plist with additional information for an object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'plotinfo' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.plotinfo')">plotinfo</a></p> + </td> + <td> + <p>plist with the plot information</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- Property: 'name' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.name')">name</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>name of the object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'description' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.description')">description</a></p> + </td> + <td> + <p>description of the object</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'mdlfile' --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm.mdlfile')">mdlfile</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>model xml file of the LTPDAworkbench</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- Property: 'UUID' --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm.UUID')">UUID</a></p> + </td> + <td> + <p>Universally Unique Identifier of 128-bit</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + </tbody> + </table> + </p> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <h2 class="title"><a name="top_methods"/>Methods</h2> + <!-- ===== link box: Begin ===== --> + <p> + <table border="1" width="80%"> + <tr> + <td> + <table border="0" cellpadding="5" class="subcategorylist" width="100%"> + <colgroup> + <col width="37%"/> + <col width="63%"/> + </colgroup> + <tbody> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#constructor">Constructor</a> + </td> + <td>Constructor of this class</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#converter">Converter</a> + </td> + <td>Convertor methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#helper">Helper</a> + </td> + <td>Helper methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#internal">Internal</a> + </td> + <td>Internal methods only for internal usage</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#operator">Operator</a> + </td> + <td>Operator methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#output">Output</a> + </td> + <td>Output methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#relational_operator">Relational Operator</a> + </td> + <td>Relational operator methods</td> + </tr> + <tr valign="top"> + <td> + <a href="class_desc_ssm.html#signal_processing">Signal Processing</a> + </td> + <td>Signal processing methods</td> + </tr> + </tbody> + </table> + </td> + </tr> + </table> + </p> + <!-- ===== link box: End ====== --> + + <!-- ===== Top of page ===== --> + <a href="#top_of_page"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top"/> + Back to Top + </a> + + <!-- ===== Methods Category: Constructor ===== --> + <h3 class="title"><a name="constructor"/>Constructor</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uoh/rebuild --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/rebuild')">rebuild</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>REBUILD rebuilds the input objects using the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ssm/ssm --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm')">ssm</a></p> + </td> + <td> + <p>SSM statespace model class constructor.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Converter ===== --> + <h3 class="title"><a name="converter"/>Converter</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ssm/ssm2miir --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/ssm2miir')">ssm2miir</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SSM2MIIR converts a statespace model object to a miir object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/ssm2pzmodel --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/ssm2pzmodel')">ssm2pzmodel</a></p> + </td> + <td> + <p>SSM2PZMODEL converts a time-continuous statespace model object to a pzmodel</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/ssm2rational --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/ssm2rational')">ssm2rational</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SSM2RATIONAL converts a statespace model object to a rational frac. object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/ssm2ss --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/ssm2ss')">ssm2ss</a></p> + </td> + <td> + <p>SSM2SS converts a statespace model object to a MATLAB statespace object.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Helper ===== --> + <h3 class="title"><a name="helper"/>Helper</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/get --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/get')">get</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GET get a property of a object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uoh/created --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/created')">created</a></p> + </td> + <td> + <p>CREATED Returns a time object of the last modification.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/creator --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/creator')">creator</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CREATOR Extract the creator(s) from the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/csvexport --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/csvexport')">csvexport</a></p> + </td> + <td> + <p>CSVEXPORT Exports the data of an object to a csv file.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/index --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/index')">index</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>INDEX index into a 'ltpda_uoh' object array or matrix. This properly captures the history.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/requirements --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/requirements')">requirements</a></p> + </td> + <td> + <p>REQUIREMENTS Returns a list of LTPDA extension requirements for a given object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setDescription --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setDescription')">setDescription</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETDESCRIPTION sets the 'description' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setMdlfile --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setMdlfile')">setMdlfile</a></p> + </td> + <td> + <p>SETMDLFILE sets the 'mdlfile' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setName --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setName')">setName</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETNAME Sets the property 'name' of an ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setPlotinfo --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setPlotinfo')">setPlotinfo</a></p> + </td> + <td> + <p>SETPLOTINFO sets the 'plotinfo' property of a ltpda_uoh object.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/setProcinfo --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setProcinfo')">setProcinfo</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPROCINFO sets the 'procinfo' property of a ltpda_uoh object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ssm/addParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/addParameters')">addParameters</a></p> + </td> + <td> + <p>ADDPARAMETERS Adds the parameters to the model.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/duplicateInput --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/duplicateInput')">duplicateInput</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DUPLICATEINPUT copies the specified input blocks.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/parameterDiff --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/parameterDiff')">parameterDiff</a></p> + </td> + <td> + <p>PARAMETERDIFF Makes a ssm that produces the output and state derivatives.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setBlockDescriptions --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setBlockDescriptions')">setBlockDescriptions</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETBLOCKDESCRIPTIONS Sets descriptions of the specified SSM blocks.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setBlockNames --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setBlockNames')">setBlockNames</a></p> + </td> + <td> + <p>SETBLOCKNAMES Sets names of the specified SSM blocks.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setBlockProperties --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setBlockProperties')">setBlockProperties</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETBLOCKPROPERTIES Sets the specified properties of the specified SSM blocks.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setParameters')">setParameters</a></p> + </td> + <td> + <p>SETPARAMETERS Sets the values of the given parameters.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setParams --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setParams')">setParams</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPARAMS Sets the parameters of the model to the given plist.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setPortDescriptions --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setPortDescriptions')">setPortDescriptions</a></p> + </td> + <td> + <p>SETPORTDESCRIPTIONS Sets descriptions of the specified SSM ports.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setPortNames --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setPortNames')">setPortNames</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPORTNAMES Sets names of the specified SSM ports.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setPortProperties --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/setPortProperties')">setPortProperties</a></p> + </td> + <td> + <p>SETPORTPROPERTIES Sets names of the specified SSM ports.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/setPortUnits --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/setPortUnits')">setPortUnits</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETPORTUNITS Sets units of the specified SSM ports.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Internal ===== --> + <h3 class="title"><a name="internal"/>Internal</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/isprop --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/isprop')">isprop</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>ISPROP tests if the given field is one of the object properties.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_uo/bsubmit --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/bsubmit')">bsubmit</a></p> + </td> + <td> + <p>BSUBMIT Submits the given collection of objects in binary form to an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/submit --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/submit')">submit</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SUBMIT Submits the given objects to an LTPDA repository</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uo/update --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/update')">update</a></p> + </td> + <td> + <p>UPDATE Updates the given object in an LTPDA repository</p> + </td> + <td> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/string --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/string')">string</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>STRING writes a command string that can be used to recreate the input object(s).</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/type --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/type')">type</a></p> + </td> + <td> + <p>TYPE converts the input objects to MATLAB functions.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ssm/generateConstructorPlist --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/generateConstructorPlist')">generateConstructorPlist</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GENERATECONSTRUCTORPLIST generates a PLIST from the properties which can rebuild the object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/ssm2dot --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/ssm2dot')">ssm2dot</a></p> + </td> + <td> + <p>SSM2DOT converts a statespace model object a DOT file.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Operator ===== --> + <h3 class="title"><a name="operator"/>Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ssm/CPSD --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/CPSD')">CPSD</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>CPSD computes the output theoretical CPSD shape with given inputs.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/PSD --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/PSD')">PSD</a></p> + </td> + <td> + <p>PSD computes the output theoretical CPSD shape with given inputs.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/append --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/append')">append</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>appends embedded subsytems, with exogenous inputs</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/assemble --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/assemble')">assemble</a></p> + </td> + <td> + <p>assembles embedded subsytems, with exogenous inputs</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/cpsdForCorrelatedInputs --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/cpsdForCorrelatedInputs')">cpsdForCorrelatedInputs</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>cpsdForCorrelatedInputs computes the output theoretical CPSD shape with given inputs.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/cpsdForIndependentInputs --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/cpsdForIndependentInputs')">cpsdForIndependentInputs</a></p> + </td> + <td> + <p>CPSDFORINDEPENDENTINPUTS computes the output theoretical CPSD shape with given inputs.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/kalman --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/kalman')">kalman</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>KALMAN applies Kalman filtering to a discrete ssm with given i/o</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/keepParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/keepParameters')">keepParameters</a></p> + </td> + <td> + <p>KEEPPARAMETERS enables to substitute symbollic patameters</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/modifyTimeStep --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/modifyTimeStep')">modifyTimeStep</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>MODIFYTIMESTEP modifies the timestep of a ssm object</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/optimiseForFitting --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/optimiseForFitting')">optimiseForFitting</a></p> + </td> + <td> + <p>OPTIMISEFORFITTING reduces the system matrices to doubles and strings.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/reorganize --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/reorganize')">reorganize</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>REOGANIZE rearranges a ssm object for fast input to BODE, SIMULATE, PSD.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/sMinReal --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/sMinReal')">sMinReal</a></p> + </td> + <td> + <p>SMINREAL gives a minimal realization of a ssm object by deleting unreached states</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/simplify --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/simplify')">simplify</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SIMPLIFY enables to do model simplification</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/simulate --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/simulate')">simulate</a></p> + </td> + <td> + <p>SIMULATE simulates a discrete ssm with given inputs</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/steadyState --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/steadyState')">steadyState</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>STEADYSTATE returns a possible value for the steady state of an ssm.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/subsParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/subsParameters')">subsParameters</a></p> + </td> + <td> + <p>SUBSPARAMETERS enables to substitute symbolic patameters</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Output ===== --> + <h3 class="title"><a name="output"/>Output</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_uo/save --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/save')">save</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SAVE overloads save operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uo</p> + </td> + </tr> + <!-- ltpda_uoh/report --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/report')">report</a></p> + </td> + <td> + <p>REPORT generates an HTML report about the input objects.</p> + </td> + <td> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ltpda_uoh/viewHistory --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/viewHistory')">viewHistory</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>VIEWHISTORY Displays the history of an object as a dot-view or a MATLAB figure.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_uoh</p> + </td> + </tr> + <!-- ssm/char --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/char')">char</a></p> + </td> + <td> + <p>CHAR convert a ssm object into a string.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/display --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/display')">display</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DISPLAY display ssm object.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/displayProperties --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/displayProperties')">displayProperties</a></p> + </td> + <td> + <p>DISPAYPROPERTIES displays the ssm model porperties.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/dotview --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/dotview')">dotview</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>DOTVIEW view an ssm object via the DOT interpreter.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/double --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/double')">double</a></p> + </td> + <td> + <p>Convert a statespace model object to double arrays for given i/o</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/findParameters --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/findParameters')">findParameters</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>findParameters returns parameter names matching the given pattern.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/getParameters --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/getParameters')">getParameters</a></p> + </td> + <td> + <p>getParameters returns parameter values for the given names.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/getParams --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/getParams')">getParams</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GETPARAMS returns the parameter list for this SSM model.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/isStable --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/isStable')">isStable</a></p> + </td> + <td> + <p>ISSTABLE tells if ssm is numerically stable</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/settlingTime --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/settlingTime')">settlingTime</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>SETTLINGTIME retunrns 1% the settling time of the system.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Relational_Operator ===== --> + <h3 class="title"><a name="relational_operator"/>Relational Operator</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ltpda_obj/eq --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/eq')">eq</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>EQ overloads the == operator for ltpda objects.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ltpda_obj</p> + </td> + </tr> + <!-- ltpda_obj/ne --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/ne')">ne</a></p> + </td> + <td> + <p>NE overloads the ~= operator for ltpda objects.</p> + </td> + <td> + <p>ltpda_obj</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ===== Methods Category: Signal_Processing ===== --> + <h3 class="title"><a name="signal_processing"/>Signal Processing</h3> + <p> + <table cellspacing="0" class="body" cellpadding="2" border="0" width="80%"> + <colgroup> + <col width="15%"/> + <col width="73%"/> + <col width="12%"/> + </colgroup> + <thead> + <tr valign="top"> + <th class="categorylist">Methods</th> + <th class="categorylist">Description</th> + <th class="categorylist">Defined in class</th> + </tr> + </thead> + <tbody> + <!-- ssm/bode --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/bode')">bode</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>BODE makes a bode plot from the given inputs to outputs.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/bodecst --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/bodecst')">bodecst</a></p> + </td> + <td> + <p>BODECST makes a bodecst plot from the given inputs to outputs.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/generateCovariance --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/generateCovariance')">generateCovariance</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>GENERATECOVARIANCE generates a default covarance matrix.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + <!-- ssm/resp --> + <tr valign="top"> + <td> + <p><a href="matlab:doc('ssm/resp')">resp</a></p> + </td> + <td> + <p>RESP gives the timewise impulse response of a statespace model.</p> + </td> + <td> + <p>ssm</p> + </td> + </tr> + <!-- ssm/respcst --> + <tr valign="top"> + <td bgcolor="#f3f4f5"> + <p><a href="matlab:doc('ssm/respcst')">respcst</a></p> + </td> + <td bgcolor="#f3f4f5"> + <p>RESPCST gives the timewise impulse response of a statespace model.</p> + </td> + <td bgcolor="#f3f4f5"> + <p>ssm</p> + </td> + </tr> + </tbody> + </table> + <!-- ===== Back to Top of Methods ===== --> + <a href="#top_methods"> + <img src="doc_to_top_up.gif" border="0" align="bottom" alt="Back to Top of Section"/> + Back to Top of Section + </a> + + </p> + + <!-- ================================================== --> + <!-- END CONTENT FILE --> + <!-- ================================================== --> + + </p> + + <br> + <br> + <table class="nav" summary="Navigation aid" border="0" width= + "100%" cellpadding="0" cellspacing="0"> + <tr valign="top"> + <td align="left" width="20"><a href="class_desc_smodel.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "smodel Class"></a> </td> + + <td align="left">smodel Class</td> + + <td> </td> + + <td align="right">timespan Class</td> + + <td align="right" width="20"><a href= + "class_desc_timespan.html"><img src="b_next.gif" border="0" align= + "bottom" alt="timespan Class"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>