Mercurial > hg > ltpda
diff m-toolbox/html_help/help/ug/ao_plot.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/ao_plot.html Wed Nov 23 19:22:13 2011 +0100 @@ -0,0 +1,134 @@ +<!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>Plotting Analysis Objects (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= + "ao_save.html"><img src="b_prev.gif" border="0" align= + "bottom" alt="Saving Analysis Objects"></a> <a href= + "collection_objects.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Collection objects"></a></td> + </tr> + </table> + + <h1 class="title"><a name="f3-12899" id="f3-12899"></a>Plotting Analysis Objects</h1> + <hr> + + <p> + <p> + The data in an AO can be plotted using the <tt>iplot</tt> method. +</p> +<p> + The <tt>iplot</tt> method provides an advanced plotting interface for AOs which tries to make good use of all the information + contained within the input AOs. For example, if the <tt>xunits</tt> and <tt>yunits</tt> fields of the input AOs are set, these labels + are used on the plot labels. +</p> + +<p> + In addition, <tt>iplot</tt> can be configured using a input <tt>plist</tt>. The following examples show some of the + possible ways to use <tt>iplot</tt> +</p> + +<div class="fragment"><pre> + >> a1 = ao(plist(<span class="string">'tsfcn'</span>, <span class="string">'sin(2*pi*0.3*t) + randn(size(t))'</span>, <span class="string">'fs'</span>, 10, <span class="string">'nsecs'</span>, 20)) + ----------- ao 01: a1 ----------- + + name: None + data: (0,0.887479404587351) (0.1,-0.449797172615395) (0.2,0.479022102390939) ... + -------- tsdata 01 ------------ + + fs: 10 + x: [200 1], double + y: [200 1], double + dx: [0 0], double + dy: [0 0], double + xunits: [s] + yunits: [] + nsecs: 20 + t0: 1970-01-01 00:00:00.000 + ------------------------------- + + hist: ao / ao / SId: fromTSfcn ... $-->$Id: ao ... S + mdlfile: empty + description: + UUID: 67d31c2f-8ee5-42ba-a96b-cfb288ecc9ea + --------------------------------- + + >> a1.data + -------- tsdata 01 ------------ + + fs: 10 + x: [200 1], double + y: [200 1], double + dx: [0 0], double + dy: [0 0], double + xunits: [s] + yunits: [] + nsecs: 20 + t0: 1970-01-01 00:00:00.000 + ------------------------------- +</pre></div> +<p> Creates a time-series AO. If we look at the data object contained in this AO, we see that the <tt>xunits</tt> +are set to the defaults of seconds [s].</p> +<p>If we plot this object with <tt>iplot</tt> we see these units reflected in the x and y axis labels.</p> +<div class="fragment"><pre> + >> iplot(a1) +</pre></div> + +<img src="images/ao_iplot_eg1.png" alt="AO iplot eg1" border="3" width="600px"> + +<p>We also see that the time-origin of the data (<tt>t0</tt> field of the <tt>tsdata</tt> class) is displayed as the plot title.</p> + + + + + + + </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="ao_save.html"><img src= + "b_prev.gif" border="0" align="bottom" alt= + "Saving Analysis Objects"></a> </td> + + <td align="left">Saving Analysis Objects</td> + + <td> </td> + + <td align="right">Collection objects</td> + + <td align="right" width="20"><a href= + "collection_objects.html"><img src="b_next.gif" border="0" align= + "bottom" alt="Collection objects"></a></td> + </tr> + </table><br> + + <p class="copy">©LTP Team</p> +</body> +</html>