Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/ssm_building_content.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/ssm_building_content.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,48 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<HTML> +<HEAD> + <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252"> + <TITLE></TITLE> + <META NAME="GENERATOR" CONTENT="OpenOffice.org 3.1 (Win32)"> + <META NAME="CREATED" CONTENT="0;0"> + <META NAME="CHANGEDBY" CONTENT="Adrien G"> + <META NAME="CHANGED" CONTENT="20090827;17393200"> +</HEAD> +<BODY LANG="en-US" DIR="LTR"> +<H2>How to build a ssm object. +</H2> +<UL> + <LI><P><FONT COLOR="#000000">The empty constructor creates an empty + statespace model</FONT></P> + <DIV CLASS="fragment"><PRE><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> </FONT></FONT></FONT>s = ssm()</PRE></DIV> +</UL> +<UL> + <LI><P><FONT COLOR="#000000">Models can be built out of built-in + models (mfiles stored in a folder), out of a description with a + plist, from a repository or a xml file, but also out of a pzmodel, a + rational or a miir model. Conversion out of a parFrac object is not + implemented yet.</FONT></P> + <DIV CLASS="fragment"><PRE><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> </FONT></FONT></FONT>s = ssm(<pzmodel>)<BR><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> </FONT></FONT></FONT>s = ssm(<miir>)<BR><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> </FONT></FONT></FONT>s = ssm(<rational>)</PRE></DIV> +</UL> +<UL> + <LI><P><FONT COLOR="#000000">This creates a new statespace model by + loading the object from disk, either out of an xml file or a .mat + file. The latter is not recommended as Matlab data format poses some + new retro-compatibility issues at each new release.</FONT></P> + <DIV CLASS="fragment"><PRE><FONT SIZE=2><FONT FACE="Courier New, monospace"><FONT COLOR="#000000">>> s = ssm(</FONT><FONT COLOR="#a020f0">'a1.xml'</FONT><FONT COLOR="#000000">)<BR></FONT></FONT></FONT><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> s = ssm(</FONT></FONT></FONT><FONT COLOR="#a020f0"><FONT FACE="Courier New, monospace"><FONT SIZE=2>'a1.mat'</FONT></FONT></FONT><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>)</FONT></FONT></FONT></PRE></DIV> +</UL> +<UL> + <LI><P><FONT COLOR="#000000">For internal use (see built-in models), + a structure constructor is available. This is constructor should not + be used – except inside a built-in model – as it does + not increment history, making it impossible to rebuild the object.</FONT></P> + <DIV CLASS="fragment"><PRE><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>>> </FONT></FONT></FONT>s = ssm(<struct>)</PRE></DIV> +</UL> +<UL> + <LI><P><FONT COLOR="#000000">There are dedicated help pages on how + to build a model out of a built-in object or a plist description.</FONT></P> + <DIV CLASS="fragment"><PRE><FONT COLOR="#000000">>> system = ssm(plist(<FONT COLOR="#a020f0">'built-in'</FONT>, <FONT COLOR="#a020f0">'<model name>'</FONT>))<BR></FONT><FONT COLOR="#000000">>> system = ssm(plist(</FONT><FONT COLOR="#a020f0">'built-in'</FONT><FONT COLOR="#000000">, </FONT><FONT COLOR="#000000"><model number>))</FONT> +>> system = ssm(plist(<FONT COLOR="#a020f0">'amats'</FONT>, <a matrices> ... ))</PRE></DIV> +</UL> +</BODY> +</HTML> \ No newline at end of file