Mercurial > hg > ltpda

view m-toolbox/html_help/help/ug/class_desc_fsdata_content.html @ 0:f0afece42f48

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import.
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 23 Nov 2011 19:22:13 +0100
parents
children
line wrap: on
line source

<!-- $Id: class_desc_fsdata_content.html,v 1.12 2009/03/17 17:14:03 ingo Exp $ -->

  <!-- ================================================== -->
  <!--                 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_fsdata.html#top_properties">Properties</a>
                </td>
                <td>Properties of the class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_fsdata.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_main.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: 't0' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>t0</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Time-stamp of the first data sample</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</p>
          </td>
        </tr>
        <!-- Property: 'navs' -->
        <tr valign="top">
          <td>
            <p><tt>navs</tt></p>
          </td>
          <td>
            <p>Number of averages</p>
          </td>
          <td>
            <p>fsdata</p>
          </td>
        </tr>
        <!-- Property: 'fs' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>fs</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Sample rate of data</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</p>
          </td>
        </tr>
        <!-- Property: 'enbw' -->
        <tr valign="top">
          <td>
            <p><tt>enbw</tt></p>
          </td>
          <td>
            <p>Equivalent noise bandwidth</p>
          </td>
          <td>
            <p>fsdata</p>
          </td>
        </tr>
        <!-- Property: 'version' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>version</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CVS version string of the constructor</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</p>
          </td>
        </tr>
        <!-- Property: 'xunits' -->
        <tr valign="top">
          <td>
            <p><tt>xunits</tt></p>
          </td>
          <td>
            <p>Units of the x-axis</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- Property: 'yunits' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>yunits</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Units of the y-axis</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- Property: 'x' -->
        <tr valign="top">
          <td>
            <p><tt>x</tt></p>
          </td>
          <td>
            <p>Data values of the x-axis</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- Property: 'y' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>y</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Data values of the y-axis</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- Property: 'dx' -->
        <tr valign="top">
          <td>
            <p><tt>dx</tt></p>
          </td>
          <td>
            <p>Error on x values</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- Property: 'dy' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>dy</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Error on y values</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</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_fsdata.html#constructor">Constructor</a>
                </td>
                <td>Constructor of this class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_fsdata.html#helper">Helper</a>
                </td>
                <td>Helper methods only for internal usage</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_fsdata.html#internal">Internal</a>
                </td>
                <td>Internal methods only for internal usage</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_fsdata.html#output">Output</a>
                </td>
                <td>Output methods</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_fsdata.html#relational_operator">Relational Operator</a>
                </td>
                <td>Relational operator 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>
        <!-- fsdata/fsdata -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('fsdata')">fsdata</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>FSDATA frequency-series object class constructor.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</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('ltpda_obj/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_obj/isprop -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('ltpda_obj/isprop')">isprop</a></p>
          </td>
          <td>
            <p>ISPROP tests if the given field is one of the object properties.</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: 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>
        <!-- data2D/applymethod -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/applymethod')">applymethod</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>APPLYMETHOD applys the given method to the input 2D data.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/applyoperator -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/applyoperator')">applyoperator</a></p>
          </td>
          <td>
            <p>APPLYOPERATOR applys the given operator to the two input data objects.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/getDx -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/getDx')">getDx</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>GETDX Get the property 'dx'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/getDy -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/getDy')">getDy</a></p>
          </td>
          <td>
            <p>GETDY Get the property 'dy'.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/getX -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/getX')">getX</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>GETX Get the property 'x'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/getY -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/getY')">getY</a></p>
          </td>
          <td>
            <p>GETY Get the property 'y'.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setDx -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/setDx')">setDx</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETDX Set the property 'dx'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setDy -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/setDy')">setDy</a></p>
          </td>
          <td>
            <p>SETDY Set the property 'dy'.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setX -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/setX')">setX</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETX Set the property 'x'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setXY -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/setXY')">setXY</a></p>
          </td>
          <td>
            <p>SETXY Set the property 'xy'.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setXunits -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/setXunits')">setXunits</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETXUNITS Set the property 'xunits'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setY -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('data2D/setY')">setY</a></p>
          </td>
          <td>
            <p>SETY Set the property 'y'.</p>
          </td>
          <td>
            <p>data2D</p>
          </td>
        </tr>
        <!-- data2D/setYunits -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/setYunits')">setYunits</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETYUNITS Set the property 'yunits'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- fsdata/setEnbw -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('fsdata/setEnbw')">setEnbw</a></p>
          </td>
          <td>
            <p>SETENBW Set the property 'enbw'.</p>
          </td>
          <td>
            <p>fsdata</p>
          </td>
        </tr>
        <!-- fsdata/setFs -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('fsdata/setFs')">setFs</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETFS Set the property 'fs'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</p>
          </td>
        </tr>
        <!-- fsdata/setNavs -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('fsdata/setNavs')">setNavs</a></p>
          </td>
          <td>
            <p>SETNAVS Set the property 'navs'.</p>
          </td>
          <td>
            <p>fsdata</p>
          </td>
        </tr>
        <!-- fsdata/setT0 -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('fsdata/setT0')">setT0</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>SETT0 Set the property 't0'.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>fsdata</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>
        <!-- data2D/char -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('data2D/char')">char</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CHAR convert a ltpda_data-object into a string.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>data2D</p>
          </td>
        </tr>
        <!-- fsdata/display -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('fsdata/display')">display</a></p>
          </td>
          <td>
            <p>DISPLAY implement terminal display for fsdata object.</p>
          </td>
          <td>
            <p>fsdata</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('ltpda_obj/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('ltpda_obj/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>

  <!-- ================================================== -->
  <!--                  END CONTENT FILE                  -->
  <!-- ================================================== -->