Mercurial > hg > ltpda

view m-toolbox/html_help/help/ug/class_desc_specwin_content.html @ 49:0bcdf74587d1 database-connection-manager

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Cleanup
author Daniele Nicolodi <nicolodi@science.unitn.it>
date Wed, 07 Dec 2011 17:24:36 +0100
parents f0afece42f48
children
line wrap: on
line source

<!-- $Id: class_desc_specwin_content.html,v 1.11 2009/03/17 16:52:04 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_specwin.html#top_properties">Properties</a>
                </td>
                <td>Properties of the class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_specwin.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_specwin.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: 'type' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>type</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Name of the spectral window object</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'alpha' -->
        <tr valign="top">
          <td>
            <p><tt>alpha</tt></p>
          </td>
          <td>
            <p>Alpha parameter for various window functions</p>
          </td>
          <td>
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'psll' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>psll</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Peak sidelobe level</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'rov' -->
        <tr valign="top">
          <td>
            <p><tt>rov</tt></p>
          </td>
          <td>
            <p>Recommended overlap</p>
          </td>
          <td>
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'nenbw' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>nenbw</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Normalised equivalent noise bandwidth</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'w3db' -->
        <tr valign="top">
          <td>
            <p><tt>w3db</tt></p>
          </td>
          <td>
            <p>dB bandwidth in bins</p>
          </td>
          <td>
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'flatness' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>flatness</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Window flatness</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'ws' -->
        <tr valign="top">
          <td>
            <p><tt>ws</tt></p>
          </td>
          <td>
            <p>Sum of window values</p>
          </td>
          <td>
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'ws2' -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><tt>ws2</tt></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>Sum of squares of window values</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- Property: 'win' -->
        <tr valign="top">
          <td>
            <p><tt>win</tt></p>
          </td>
          <td>
            <p>Window samples (column vector)</p>
          </td>
          <td>
            <p>specwin</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>specwin</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_specwin.html#constructor">Constructor</a>
                </td>
                <td>Constructor of this class</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_specwin.html#helper">Helper</a>
                </td>
                <td>Helper methods only for internal usage</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_specwin.html#output">Output</a>
                </td>
                <td>Output methods</td>
              </tr>
              <tr valign="top">
                <td>
                  <a href="class_desc_specwin.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>
        <!-- specwin/specwin -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('specwin')">specwin</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>% SPECWIN spectral window object class constructor.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</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: 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>
        <!-- specwin/char -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('specwin/char')">char</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>CHAR convert a specwin object into a string.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- specwin/display -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('specwin/display')">display</a></p>
          </td>
          <td>
            <p>DISPLAY overloads display functionality for specwin objects.</p>
          </td>
          <td>
            <p>specwin</p>
          </td>
        </tr>
        <!-- specwin/plot -->
        <tr valign="top">
          <td bgcolor="#f3f4f5">
            <p><a href="matlab:doc('specwin/plot')">plot</a></p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>PLOT plots a specwin object.</p>
          </td>
          <td bgcolor="#f3f4f5">
            <p>specwin</p>
          </td>
        </tr>
        <!-- specwin/string -->
        <tr valign="top">
          <td>
            <p><a href="matlab:doc('specwin/string')">string</a></p>
          </td>
          <td>
            <p>STRING writes a command string that can be used to recreate the input window object.</p>
          </td>
          <td>
            <p>specwin</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                  -->
  <!-- ================================================== -->