/apidocs/echonest.audio.AudioQuantum-class.html
http://echo-nest-remix.googlecode.com/ · HTML · 806 lines · 728 code · 54 blank · 24 comment · 0 complexity · 962bf7a87995f7bfc0b605fe5a86463b MD5 · raw file
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>echonest.audio.AudioQuantum</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- <a href="echonest-module.html">Package echonest</a> ::
- <a href="echonest.audio-module.html">Module audio</a> ::
- Class AudioQuantum
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="echonest.audio.AudioQuantum-class.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== CLASS DESCRIPTION ==================== -->
- <h1 class="epydoc">Class AudioQuantum</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum">source code</a></span></p>
- <center>
- </center>
- <hr />
- <p>A unit of musical time, identified at minimum with a start time and
- a duration, both in seconds. It most often corresponds with a <code class="link">section</code>,
- <code class="link">bar</code>, <code class="link">beat</code>, <code class="link">tatum</code>, or (by inheritance) <code class="link">segment</code> obtained from an Analyze
- API call.</p>
- <p>Additional properties include:</p>
- <dl class="rst-docutils">
- <dt>end</dt>
- <dd>computed time offset for convenience: <code class="link">start</code> + <code class="link">duration</code></dd>
- <dt>container</dt>
- <dd>a circular reference to the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>,
- created upon creation of the <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> that covers
- the whole track</dd>
- </dl>
- <!-- ==================== INSTANCE METHODS ==================== -->
- <a name="section-InstanceMethods"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Instance Methods</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-InstanceMethods"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0</span>,
- <span class="summary-sig-arg">duration</span>=<span class="summary-sig-default">0</span>,
- <span class="summary-sig-arg">kind</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">confidence</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">source</span>=<span class="summary-sig-default">None</span>)</span><br />
- Initializes an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__init__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="get_end"></a><span class="summary-sig-name">get_end</span>(<span class="summary-sig-arg">self</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.get_end">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="get_source"></a><span class="summary-sig-name">get_source</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns itself or its parent.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.get_source">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="set_source"></a><span class="summary-sig-name">set_source</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">value</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.set_source">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="parent"></a><span class="summary-sig-name">parent</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns the containing <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> in the rhythm hierarchy:
- a <code class="link">tatum</code> returns a <code class="link">beat</code>, a <code class="link">beat</code> returns a <code class="link">bar</code>, and a <code class="link">bar</code> returns a
- <code class="link">section</code>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.parent">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#children" class="summary-sig-name">children</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns an <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> of the AudioQuanta that it contains,
- one step down the hierarchy.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.children">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#group" class="summary-sig-name">group</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns the <a href="echonest.audio.AudioQuantum-class.html#children" class="link">children</a>() of the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>'s <a href="echonest.audio.AudioQuantum-class.html#parent" class="link">parent</a>().</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.group">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#prev" class="summary-sig-name">prev</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">step</span>=<span class="summary-sig-default">1</span>)</span><br />
- Step backwards in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.prev">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#next" class="summary-sig-name">next</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">step</span>=<span class="summary-sig-default">1</span>)</span><br />
- Step forward in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.next">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#__str__" class="summary-sig-name">__str__</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Lists the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.kind with start and
- end times, in seconds, e.g.:</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__str__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#__repr__" class="summary-sig-name">__repr__</a>(<span class="summary-sig-arg">self</span>)</span><br />
- A string representing a constructor, including kind, start time,
- duration, and (if it exists) confidence, e.g.:</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__repr__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="local_context"></a><span class="summary-sig-name">local_context</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns a tuple of (<em>index</em>, <em>length</em>) within rhythm siblings, where
- <em>index</em> is the (zero-indexed) position within its <a href="echonest.audio.AudioQuantum-class.html#group" class="link">group</a>(), and
- <em>length</em> is the number of siblings within its <a href="echonest.audio.AudioQuantum-class.html#group" class="link">group</a>().</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.local_context">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="absolute_context"></a><span class="summary-sig-name">absolute_context</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns a tuple of (<em>index</em>, <em>length</em>) within the containing
- <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>, where <em>index</em> is the (zero-indexed) position within
- its container, and <em>length</em> is the number of siblings within the
- container.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.absolute_context">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#context_string" class="summary-sig-name">context_string</a>(<span class="summary-sig-arg">self</span>)</span><br />
- Returns a one-indexed, human-readable version of context.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.context_string">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="__getstate__"></a><span class="summary-sig-name">__getstate__</span>(<span class="summary-sig-arg">self</span>)</span><br />
- Eliminates the circular reference for pickling.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__getstate__">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="toxml"></a><span class="summary-sig-name">toxml</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.toxml">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0.0</span>,
- <span class="summary-sig-arg">to_audio</span>=<span class="summary-sig-default">None</span>,
- <span class="summary-sig-arg">with_source</span>=<span class="summary-sig-default">None</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.render">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
- <code><a href="echonest.audio.AudioRenderable-class.html#encode">encode</a></code>,
- <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>,
- <code><a href="echonest.audio.AudioRenderable-class.html#sources">sources</a></code>
- </p>
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__delattr__</code>,
- <code>__format__</code>,
- <code>__getattribute__</code>,
- <code>__hash__</code>,
- <code>__new__</code>,
- <code>__reduce__</code>,
- <code>__reduce_ex__</code>,
- <code>__setattr__</code>,
- <code>__sizeof__</code>,
- <code>__subclasshook__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== STATIC METHODS ==================== -->
- <a name="section-StaticMethods"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Static Methods</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-StaticMethods"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
- <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== PROPERTIES ==================== -->
- <a name="section-Properties"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Properties</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Properties"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioQuantum-class.html#end" class="summary-name">end</a><br />
- A computed property: the sum of <code class="link">start</code> and <code class="link">duration</code>.
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a href="echonest.audio.AudioQuantum-class.html#source" class="summary-name">source</a><br />
- The <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> source for the AudioQuantum.
- </td>
- </tr>
- <tr>
- <td colspan="2" class="summary">
- <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
- <code>__class__</code>
- </p>
- </td>
- </tr>
- </table>
- <!-- ==================== METHOD DETAILS ==================== -->
- <a name="section-MethodDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Method Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-MethodDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="__init__"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">start</span>=<span class="sig-default">0</span>,
- <span class="sig-arg">duration</span>=<span class="sig-default">0</span>,
- <span class="sig-arg">kind</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">confidence</span>=<span class="sig-default">None</span>,
- <span class="sig-arg">source</span>=<span class="sig-default">None</span>)</span>
- <br /><em class="fname">(Constructor)</em>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__init__">source code</a></span>
- </td>
- </tr></table>
-
- Initializes an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.
- <dl class="fields">
- <dt>Parameters:</dt>
- <dd><ul class="nomargin-top">
- <li><strong class="pname"><code>start</code></strong> - offset from the start of the track, in seconds</li>
- <li><strong class="pname"><code>duration</code></strong> - length of the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a></li>
- <li><strong class="pname"><code>kind</code></strong> - string containing what kind of rhythm unit it came from</li>
- <li><strong class="pname"><code>confidence</code></strong> - float between zero and one</li>
- </ul></dd>
- <dt>Overrides:
- object.__init__
- </dt>
- </dl>
- </td></tr></table>
- </div>
- <a name="children"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">children</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.children">source code</a></span>
- </td>
- </tr></table>
-
- Returns an <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> of the AudioQuanta that it contains,
- one step down the hierarchy. A <code class="link">beat</code> returns <code class="link">tatums</code>, a <code class="link">bar</code> returns
- <code class="link">beats</code>, and a <code class="link">section</code> returns <code class="link">bars</code>.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="group"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">group</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.group">source code</a></span>
- </td>
- </tr></table>
-
- Returns the <a href="echonest.audio.AudioQuantum-class.html#children" class="link">children</a>() of the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>'s <a href="echonest.audio.AudioQuantum-class.html#parent" class="link">parent</a>().
- In other words: 'siblings'. If no parent is found, then return the
- <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> for the whole track.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="prev"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">prev</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">step</span>=<span class="sig-default">1</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.prev">source code</a></span>
- </td>
- </tr></table>
-
- Step backwards in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.
- Returns <code class="link">self</code> if a boundary is reached.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="next"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">next</span>(<span class="sig-arg">self</span>,
- <span class="sig-arg">step</span>=<span class="sig-default">1</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.next">source code</a></span>
- </td>
- </tr></table>
-
- Step forward in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.
- Returns <code class="link">self</code> if a boundary is reached.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="__str__"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
- <br /><em class="fname">(Informal representation operator)</em>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__str__">source code</a></span>
- </td>
- </tr></table>
-
- <p>Lists the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.kind with start and
- end times, in seconds, e.g.:</p>
- <pre class="rst-literal-block">
- "segment (20.31 - 20.42)"
- </pre>
- <dl class="fields">
- <dt>Overrides:
- object.__str__
- </dt>
- </dl>
- </td></tr></table>
- </div>
- <a name="__repr__"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
- <br /><em class="fname">(Representation operator)</em>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__repr__">source code</a></span>
- </td>
- </tr></table>
-
- <p>A string representing a constructor, including kind, start time,
- duration, and (if it exists) confidence, e.g.:</p>
- <pre class="rst-literal-block">
- "AudioQuantum(kind='tatum', start=42.198267, duration=0.1523394)"
- </pre>
- <dl class="fields">
- <dt>Overrides:
- object.__repr__
- </dt>
- </dl>
- </td></tr></table>
- </div>
- <a name="context_string"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">context_string</span>(<span class="sig-arg">self</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.context_string">source code</a></span>
- </td>
- </tr></table>
-
- <p>Returns a one-indexed, human-readable version of context.
- For example:</p>
- <pre class="rst-literal-block">
- "bar 4 of 142, beat 3 of 4, tatum 2 of 3"
- </pre>
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== PROPERTY DETAILS ==================== -->
- <a name="section-PropertyDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Property Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-PropertyDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="end"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">end</h3>
- A computed property: the sum of <code class="link">start</code> and <code class="link">duration</code>.
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#get_end" class="summary-sig-name">get_end</a>(<span class="summary-sig-arg">self</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <a name="source"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <h3 class="epydoc">source</h3>
- The <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> source for the AudioQuantum.
- <dl class="fields">
- <dt>Get Method:</dt>
- <dd class="value"><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#get_source" class="summary-sig-name">get_source</a>(<span class="summary-sig-arg">self</span>)</span>
- - Returns itself or its parent.
- </dd>
- <dt>Set Method:</dt>
- <dd class="value"><span class="summary-sig"><a href="echonest.audio.AudioQuantum-class.html#set_source" class="summary-sig-name">set_source</a>(<span class="summary-sig-arg">self</span>,
- <span class="summary-sig-arg">value</span>)</span>
- </dd>
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:58 2010
- </td>
- <td align="right" class="footer">
- <a target="mainFrame" href="http://epydoc.sourceforge.net"
- >http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie();
- // -->
- </script>
- </body>
- </html>