Mercurial > hg > ltpda

view m-toolbox/html_help/help/ug/ssm_building.html @ 13:e05504b18072 database-connection-manager

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move more functions to utils.repository
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Mon, 05 Dec 2011 16:20:06 +0100
parents f0afece42f48
children
line wrap: on
line source

<!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>Building Statespace models (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;">&nbsp;</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=
      "ssm_introduction.html"><img src="b_prev.gif" border="0" align=
      "bottom" alt="Introduction to Statespace Models with LTPDA"></a>&nbsp;&nbsp;&nbsp;<a href=
      "ssm_build_description.html"><img src="b_next.gif" border="0" align=
      "bottom" alt="Building from scratch"></a></td>
    </tr>
  </table>

  <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Building Statespace models</h1>
  <hr>
  
  <p>
	<!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>&gt;&gt; </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>&gt;&gt; </FONT></FONT></FONT>s = ssm(&lt;pzmodel&gt;)<BR><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>&gt;&gt; </FONT></FONT></FONT>s = ssm(&lt;miir&gt;)<BR><FONT COLOR="#000000"><FONT FACE="Courier New, monospace"><FONT SIZE=2>&gt;&gt; </FONT></FONT></FONT>s = ssm(&lt;rational&gt;)</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">&gt;&gt; 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>&gt;&gt; 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 &ndash; except inside a built-in model &ndash; 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>&gt;&gt; </FONT></FONT></FONT>s = ssm(&lt;struct&gt;)</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">&gt;&gt; system = ssm(plist(<FONT COLOR="#a020f0">'built-in'</FONT>, <FONT COLOR="#a020f0">'&lt;model name&gt;'</FONT>))<BR></FONT><FONT COLOR="#000000">&gt;&gt; system = ssm(plist(</FONT><FONT COLOR="#a020f0">'built-in'</FONT><FONT COLOR="#000000">, </FONT><FONT COLOR="#000000">&lt;model number&gt;))</FONT>
&gt;&gt; system = ssm(plist(<FONT COLOR="#a020f0">'amats'</FONT>, &lt;a matrices&gt;  ... ))</PRE></DIV>
</UL>
</BODY>
</HTML>
  </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="ssm_introduction.html"><img src=
      "b_prev.gif" border="0" align="bottom" alt=
      "Introduction to Statespace Models with LTPDA"></a>&nbsp;</td>

      <td align="left">Introduction to Statespace Models with LTPDA</td>

      <td>&nbsp;</td>

      <td align="right">Building from scratch</td>

      <td align="right" width="20"><a href=
      "ssm_build_description.html"><img src="b_next.gif" border="0" align=
      "bottom" alt="Building from scratch"></a></td>
    </tr>
  </table><br>

  <p class="copy">&copy;LTP Team</p>
</body>
</html>