PageRenderTime 172ms CodeModel.GetById 60ms app.highlight 66ms RepoModel.GetById 35ms app.codeStats 0ms

/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
  1<?xml version="1.0" encoding="ascii"?>
  2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  3          "DTD/xhtml1-transitional.dtd">
  4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  5<head>
  6  <title>echonest.audio.AudioQuantum</title>
  7  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  8  <script type="text/javascript" src="epydoc.js"></script>
  9</head>
 10
 11<body bgcolor="white" text="black" link="blue" vlink="#204080"
 12      alink="#204080">
 13<!-- ==================== NAVIGATION BAR ==================== -->
 14<table class="navbar" border="0" width="100%" cellpadding="0"
 15       bgcolor="#a0c0ff" cellspacing="0">
 16  <tr valign="middle">
 17
 18  <!-- Tree link -->
 19      <th>&nbsp;&nbsp;&nbsp;<a
 20        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 21
 22  <!-- Index link -->
 23      <th>&nbsp;&nbsp;&nbsp;<a
 24        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
 25
 26  <!-- Help link -->
 27      <th>&nbsp;&nbsp;&nbsp;<a
 28        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
 29
 30  <!-- Project homepage -->
 31      <th class="navbar" align="right" width="100%">
 32        <table border="0" cellpadding="0" cellspacing="0">
 33          <tr><th class="navbar" align="center"
 34            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
 35          </tr></table></th>
 36  </tr>
 37</table>
 38<table width="100%" cellpadding="0" cellspacing="0">
 39  <tr valign="top">
 40    <td width="100%">
 41      <span class="breadcrumbs">
 42        <a href="echonest-module.html">Package&nbsp;echonest</a> ::
 43        <a href="echonest.audio-module.html">Module&nbsp;audio</a> ::
 44        Class&nbsp;AudioQuantum
 45      </span>
 46    </td>
 47    <td>
 48      <table cellpadding="0" cellspacing="0">
 49        <!-- hide/show private -->
 50        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
 51    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
 52        <tr><td align="right"><span class="options"
 53            >[<a href="frames.html" target="_top">frames</a
 54            >]&nbsp;|&nbsp;<a href="echonest.audio.AudioQuantum-class.html"
 55            target="_top">no&nbsp;frames</a>]</span></td></tr>
 56      </table>
 57    </td>
 58  </tr>
 59</table>
 60<!-- ==================== CLASS DESCRIPTION ==================== -->
 61<h1 class="epydoc">Class AudioQuantum</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum">source&nbsp;code</a></span></p>
 62<center>
 63
 64</center>
 65<hr />
 66<p>A unit of musical time, identified at minimum with a start time and
 67a duration, both in seconds. It most often corresponds with a <code class="link">section</code>,
 68<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
 69API call.</p>
 70<p>Additional properties include:</p>
 71<dl class="rst-docutils">
 72<dt>end</dt>
 73<dd>computed time offset for convenience: <code class="link">start</code> + <code class="link">duration</code></dd>
 74<dt>container</dt>
 75<dd>a circular reference to the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>,
 76created upon creation of the <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> that covers
 77the whole track</dd>
 78</dl>
 79
 80<!-- ==================== INSTANCE METHODS ==================== -->
 81<a name="section-InstanceMethods"></a>
 82<table class="summary" border="1" cellpadding="3"
 83       cellspacing="0" width="100%" bgcolor="white">
 84<tr bgcolor="#70b0f0" class="table-header">
 85  <td colspan="2" class="table-header">
 86    <table border="0" cellpadding="0" cellspacing="0" width="100%">
 87      <tr valign="top">
 88        <td align="left"><span class="table-header">Instance Methods</span></td>
 89        <td align="right" valign="top"
 90         ><span class="options">[<a href="#section-InstanceMethods"
 91         class="privatelink" onclick="toggle_private();"
 92         >hide private</a>]</span></td>
 93      </tr>
 94    </table>
 95  </td>
 96</tr>
 97<tr>
 98    <td width="15%" align="right" valign="top" class="summary">
 99      <span class="summary-type">&nbsp;</span>
100    </td><td class="summary">
101      <table width="100%" cellpadding="0" cellspacing="0" border="0">
102        <tr>
103          <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>,
104        <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0</span>,
105        <span class="summary-sig-arg">duration</span>=<span class="summary-sig-default">0</span>,
106        <span class="summary-sig-arg">kind</span>=<span class="summary-sig-default">None</span>,
107        <span class="summary-sig-arg">confidence</span>=<span class="summary-sig-default">None</span>,
108        <span class="summary-sig-arg">source</span>=<span class="summary-sig-default">None</span>)</span><br />
109      Initializes an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
110          <td align="right" valign="top">
111            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__init__">source&nbsp;code</a></span>
112            
113          </td>
114        </tr>
115      </table>
116      
117    </td>
118  </tr>
119<tr>
120    <td width="15%" align="right" valign="top" class="summary">
121      <span class="summary-type">&nbsp;</span>
122    </td><td class="summary">
123      <table width="100%" cellpadding="0" cellspacing="0" border="0">
124        <tr>
125          <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>
126          <td align="right" valign="top">
127            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.get_end">source&nbsp;code</a></span>
128            
129          </td>
130        </tr>
131      </table>
132      
133    </td>
134  </tr>
135<tr>
136    <td width="15%" align="right" valign="top" class="summary">
137      <span class="summary-type">&nbsp;</span>
138    </td><td class="summary">
139      <table width="100%" cellpadding="0" cellspacing="0" border="0">
140        <tr>
141          <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 />
142      Returns itself or its parent.</td>
143          <td align="right" valign="top">
144            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.get_source">source&nbsp;code</a></span>
145            
146          </td>
147        </tr>
148      </table>
149      
150    </td>
151  </tr>
152<tr>
153    <td width="15%" align="right" valign="top" class="summary">
154      <span class="summary-type">&nbsp;</span>
155    </td><td class="summary">
156      <table width="100%" cellpadding="0" cellspacing="0" border="0">
157        <tr>
158          <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>,
159        <span class="summary-sig-arg">value</span>)</span></td>
160          <td align="right" valign="top">
161            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.set_source">source&nbsp;code</a></span>
162            
163          </td>
164        </tr>
165      </table>
166      
167    </td>
168  </tr>
169<tr>
170    <td width="15%" align="right" valign="top" class="summary">
171      <span class="summary-type">&nbsp;</span>
172    </td><td class="summary">
173      <table width="100%" cellpadding="0" cellspacing="0" border="0">
174        <tr>
175          <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 />
176      Returns the containing <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> in the rhythm hierarchy:
177a <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
178<code class="link">section</code>.</td>
179          <td align="right" valign="top">
180            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.parent">source&nbsp;code</a></span>
181            
182          </td>
183        </tr>
184      </table>
185      
186    </td>
187  </tr>
188<tr>
189    <td width="15%" align="right" valign="top" class="summary">
190      <span class="summary-type">&nbsp;</span>
191    </td><td class="summary">
192      <table width="100%" cellpadding="0" cellspacing="0" border="0">
193        <tr>
194          <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 />
195      Returns an <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> of the AudioQuanta that it contains,
196one step down the hierarchy.</td>
197          <td align="right" valign="top">
198            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.children">source&nbsp;code</a></span>
199            
200          </td>
201        </tr>
202      </table>
203      
204    </td>
205  </tr>
206<tr>
207    <td width="15%" align="right" valign="top" class="summary">
208      <span class="summary-type">&nbsp;</span>
209    </td><td class="summary">
210      <table width="100%" cellpadding="0" cellspacing="0" border="0">
211        <tr>
212          <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 />
213      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>
214          <td align="right" valign="top">
215            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.group">source&nbsp;code</a></span>
216            
217          </td>
218        </tr>
219      </table>
220      
221    </td>
222  </tr>
223<tr>
224    <td width="15%" align="right" valign="top" class="summary">
225      <span class="summary-type">&nbsp;</span>
226    </td><td class="summary">
227      <table width="100%" cellpadding="0" cellspacing="0" border="0">
228        <tr>
229          <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>,
230        <span class="summary-sig-arg">step</span>=<span class="summary-sig-default">1</span>)</span><br />
231      Step backwards in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.</td>
232          <td align="right" valign="top">
233            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.prev">source&nbsp;code</a></span>
234            
235          </td>
236        </tr>
237      </table>
238      
239    </td>
240  </tr>
241<tr>
242    <td width="15%" align="right" valign="top" class="summary">
243      <span class="summary-type">&nbsp;</span>
244    </td><td class="summary">
245      <table width="100%" cellpadding="0" cellspacing="0" border="0">
246        <tr>
247          <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>,
248        <span class="summary-sig-arg">step</span>=<span class="summary-sig-default">1</span>)</span><br />
249      Step forward in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.</td>
250          <td align="right" valign="top">
251            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.next">source&nbsp;code</a></span>
252            
253          </td>
254        </tr>
255      </table>
256      
257    </td>
258  </tr>
259<tr>
260    <td width="15%" align="right" valign="top" class="summary">
261      <span class="summary-type">&nbsp;</span>
262    </td><td class="summary">
263      <table width="100%" cellpadding="0" cellspacing="0" border="0">
264        <tr>
265          <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 />
266      Lists the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.kind with start and
267end times, in seconds, e.g.:</td>
268          <td align="right" valign="top">
269            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__str__">source&nbsp;code</a></span>
270            
271          </td>
272        </tr>
273      </table>
274      
275    </td>
276  </tr>
277<tr>
278    <td width="15%" align="right" valign="top" class="summary">
279      <span class="summary-type">&nbsp;</span>
280    </td><td class="summary">
281      <table width="100%" cellpadding="0" cellspacing="0" border="0">
282        <tr>
283          <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 />
284      A string representing a constructor, including kind, start time,
285duration, and (if it exists) confidence, e.g.:</td>
286          <td align="right" valign="top">
287            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__repr__">source&nbsp;code</a></span>
288            
289          </td>
290        </tr>
291      </table>
292      
293    </td>
294  </tr>
295<tr>
296    <td width="15%" align="right" valign="top" class="summary">
297      <span class="summary-type">&nbsp;</span>
298    </td><td class="summary">
299      <table width="100%" cellpadding="0" cellspacing="0" border="0">
300        <tr>
301          <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 />
302      Returns a tuple of (<em>index</em>, <em>length</em>) within rhythm siblings, where
303<em>index</em> is the (zero-indexed) position within its <a href="echonest.audio.AudioQuantum-class.html#group" class="link">group</a>(), and
304<em>length</em> is the number of siblings within its <a href="echonest.audio.AudioQuantum-class.html#group" class="link">group</a>().</td>
305          <td align="right" valign="top">
306            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.local_context">source&nbsp;code</a></span>
307            
308          </td>
309        </tr>
310      </table>
311      
312    </td>
313  </tr>
314<tr>
315    <td width="15%" align="right" valign="top" class="summary">
316      <span class="summary-type">&nbsp;</span>
317    </td><td class="summary">
318      <table width="100%" cellpadding="0" cellspacing="0" border="0">
319        <tr>
320          <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 />
321      Returns a tuple of (<em>index</em>, <em>length</em>) within the containing
322<a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>, where <em>index</em> is the (zero-indexed) position within
323its container, and <em>length</em> is the number of siblings within the
324container.</td>
325          <td align="right" valign="top">
326            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.absolute_context">source&nbsp;code</a></span>
327            
328          </td>
329        </tr>
330      </table>
331      
332    </td>
333  </tr>
334<tr>
335    <td width="15%" align="right" valign="top" class="summary">
336      <span class="summary-type">&nbsp;</span>
337    </td><td class="summary">
338      <table width="100%" cellpadding="0" cellspacing="0" border="0">
339        <tr>
340          <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 />
341      Returns a one-indexed, human-readable version of context.</td>
342          <td align="right" valign="top">
343            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.context_string">source&nbsp;code</a></span>
344            
345          </td>
346        </tr>
347      </table>
348      
349    </td>
350  </tr>
351<tr>
352    <td width="15%" align="right" valign="top" class="summary">
353      <span class="summary-type">&nbsp;</span>
354    </td><td class="summary">
355      <table width="100%" cellpadding="0" cellspacing="0" border="0">
356        <tr>
357          <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 />
358      Eliminates the circular reference for pickling.</td>
359          <td align="right" valign="top">
360            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__getstate__">source&nbsp;code</a></span>
361            
362          </td>
363        </tr>
364      </table>
365      
366    </td>
367  </tr>
368<tr>
369    <td width="15%" align="right" valign="top" class="summary">
370      <span class="summary-type">&nbsp;</span>
371    </td><td class="summary">
372      <table width="100%" cellpadding="0" cellspacing="0" border="0">
373        <tr>
374          <td><span class="summary-sig"><a name="toxml"></a><span class="summary-sig-name">toxml</span>(<span class="summary-sig-arg">self</span>,
375        <span class="summary-sig-arg">context</span>=<span class="summary-sig-default">None</span>)</span></td>
376          <td align="right" valign="top">
377            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.toxml">source&nbsp;code</a></span>
378            
379          </td>
380        </tr>
381      </table>
382      
383    </td>
384  </tr>
385<tr>
386    <td width="15%" align="right" valign="top" class="summary">
387      <span class="summary-type">&nbsp;</span>
388    </td><td class="summary">
389      <table width="100%" cellpadding="0" cellspacing="0" border="0">
390        <tr>
391          <td><span class="summary-sig"><a name="render"></a><span class="summary-sig-name">render</span>(<span class="summary-sig-arg">self</span>,
392        <span class="summary-sig-arg">start</span>=<span class="summary-sig-default">0.0</span>,
393        <span class="summary-sig-arg">to_audio</span>=<span class="summary-sig-default">None</span>,
394        <span class="summary-sig-arg">with_source</span>=<span class="summary-sig-default">None</span>)</span></td>
395          <td align="right" valign="top">
396            <span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.render">source&nbsp;code</a></span>
397            
398          </td>
399        </tr>
400      </table>
401      
402    </td>
403  </tr>
404  <tr>
405    <td colspan="2" class="summary">
406    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
407      <code><a href="echonest.audio.AudioRenderable-class.html#encode">encode</a></code>,
408      <code><a href="echonest.audio.AudioRenderable-class.html#resolve_source">resolve_source</a></code>,
409      <code><a href="echonest.audio.AudioRenderable-class.html#sources">sources</a></code>
410      </p>
411    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
412      <code>__delattr__</code>,
413      <code>__format__</code>,
414      <code>__getattribute__</code>,
415      <code>__hash__</code>,
416      <code>__new__</code>,
417      <code>__reduce__</code>,
418      <code>__reduce_ex__</code>,
419      <code>__setattr__</code>,
420      <code>__sizeof__</code>,
421      <code>__subclasshook__</code>
422      </p>
423    </td>
424  </tr>
425</table>
426<!-- ==================== STATIC METHODS ==================== -->
427<a name="section-StaticMethods"></a>
428<table class="summary" border="1" cellpadding="3"
429       cellspacing="0" width="100%" bgcolor="white">
430<tr bgcolor="#70b0f0" class="table-header">
431  <td colspan="2" class="table-header">
432    <table border="0" cellpadding="0" cellspacing="0" width="100%">
433      <tr valign="top">
434        <td align="left"><span class="table-header">Static Methods</span></td>
435        <td align="right" valign="top"
436         ><span class="options">[<a href="#section-StaticMethods"
437         class="privatelink" onclick="toggle_private();"
438         >hide private</a>]</span></td>
439      </tr>
440    </table>
441  </td>
442</tr>
443  <tr>
444    <td colspan="2" class="summary">
445    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="echonest.audio.AudioRenderable-class.html">AudioRenderable</a></code></b>:
446      <code><a href="echonest.audio.AudioRenderable-class.html#init_audio_data">init_audio_data</a></code>
447      </p>
448    </td>
449  </tr>
450</table>
451<!-- ==================== PROPERTIES ==================== -->
452<a name="section-Properties"></a>
453<table class="summary" border="1" cellpadding="3"
454       cellspacing="0" width="100%" bgcolor="white">
455<tr bgcolor="#70b0f0" class="table-header">
456  <td colspan="2" class="table-header">
457    <table border="0" cellpadding="0" cellspacing="0" width="100%">
458      <tr valign="top">
459        <td align="left"><span class="table-header">Properties</span></td>
460        <td align="right" valign="top"
461         ><span class="options">[<a href="#section-Properties"
462         class="privatelink" onclick="toggle_private();"
463         >hide private</a>]</span></td>
464      </tr>
465    </table>
466  </td>
467</tr>
468<tr>
469    <td width="15%" align="right" valign="top" class="summary">
470      <span class="summary-type">&nbsp;</span>
471    </td><td class="summary">
472        <a href="echonest.audio.AudioQuantum-class.html#end" class="summary-name">end</a><br />
473      A computed property: the sum of <code class="link">start</code> and <code class="link">duration</code>.
474    </td>
475  </tr>
476<tr>
477    <td width="15%" align="right" valign="top" class="summary">
478      <span class="summary-type">&nbsp;</span>
479    </td><td class="summary">
480        <a href="echonest.audio.AudioQuantum-class.html#source" class="summary-name">source</a><br />
481      The <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> source for the AudioQuantum.
482    </td>
483  </tr>
484  <tr>
485    <td colspan="2" class="summary">
486    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
487      <code>__class__</code>
488      </p>
489    </td>
490  </tr>
491</table>
492<!-- ==================== METHOD DETAILS ==================== -->
493<a name="section-MethodDetails"></a>
494<table class="details" border="1" cellpadding="3"
495       cellspacing="0" width="100%" bgcolor="white">
496<tr bgcolor="#70b0f0" class="table-header">
497  <td colspan="2" class="table-header">
498    <table border="0" cellpadding="0" cellspacing="0" width="100%">
499      <tr valign="top">
500        <td align="left"><span class="table-header">Method Details</span></td>
501        <td align="right" valign="top"
502         ><span class="options">[<a href="#section-MethodDetails"
503         class="privatelink" onclick="toggle_private();"
504         >hide private</a>]</span></td>
505      </tr>
506    </table>
507  </td>
508</tr>
509</table>
510<a name="__init__"></a>
511<div>
512<table class="details" border="1" cellpadding="3"
513       cellspacing="0" width="100%" bgcolor="white">
514<tr><td>
515  <table width="100%" cellpadding="0" cellspacing="0" border="0">
516  <tr valign="top"><td>
517  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
518        <span class="sig-arg">start</span>=<span class="sig-default">0</span>,
519        <span class="sig-arg">duration</span>=<span class="sig-default">0</span>,
520        <span class="sig-arg">kind</span>=<span class="sig-default">None</span>,
521        <span class="sig-arg">confidence</span>=<span class="sig-default">None</span>,
522        <span class="sig-arg">source</span>=<span class="sig-default">None</span>)</span>
523    <br /><em class="fname">(Constructor)</em>
524  </h3>
525  </td><td align="right" valign="top"
526    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__init__">source&nbsp;code</a></span>&nbsp;
527    </td>
528  </tr></table>
529  
530  Initializes an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.
531  <dl class="fields">
532    <dt>Parameters:</dt>
533    <dd><ul class="nomargin-top">
534        <li><strong class="pname"><code>start</code></strong> - offset from the start of the track, in seconds</li>
535        <li><strong class="pname"><code>duration</code></strong> - length of the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a></li>
536        <li><strong class="pname"><code>kind</code></strong> - string containing what kind of rhythm unit it came from</li>
537        <li><strong class="pname"><code>confidence</code></strong> - float between zero and one</li>
538    </ul></dd>
539    <dt>Overrides:
540        object.__init__
541    </dt>
542  </dl>
543</td></tr></table>
544</div>
545<a name="children"></a>
546<div>
547<table class="details" border="1" cellpadding="3"
548       cellspacing="0" width="100%" bgcolor="white">
549<tr><td>
550  <table width="100%" cellpadding="0" cellspacing="0" border="0">
551  <tr valign="top"><td>
552  <h3 class="epydoc"><span class="sig"><span class="sig-name">children</span>(<span class="sig-arg">self</span>)</span>
553  </h3>
554  </td><td align="right" valign="top"
555    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.children">source&nbsp;code</a></span>&nbsp;
556    </td>
557  </tr></table>
558  
559  Returns an <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> of the AudioQuanta that it contains,
560one step down the hierarchy. A <code class="link">beat</code> returns <code class="link">tatums</code>, a <code class="link">bar</code> returns
561<code class="link">beats</code>, and a <code class="link">section</code> returns <code class="link">bars</code>.
562  <dl class="fields">
563  </dl>
564</td></tr></table>
565</div>
566<a name="group"></a>
567<div>
568<table class="details" border="1" cellpadding="3"
569       cellspacing="0" width="100%" bgcolor="white">
570<tr><td>
571  <table width="100%" cellpadding="0" cellspacing="0" border="0">
572  <tr valign="top"><td>
573  <h3 class="epydoc"><span class="sig"><span class="sig-name">group</span>(<span class="sig-arg">self</span>)</span>
574  </h3>
575  </td><td align="right" valign="top"
576    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.group">source&nbsp;code</a></span>&nbsp;
577    </td>
578  </tr></table>
579  
580  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>().
581In other words: 'siblings'. If no parent is found, then return the
582<a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a> for the whole track.
583  <dl class="fields">
584  </dl>
585</td></tr></table>
586</div>
587<a name="prev"></a>
588<div>
589<table class="details" border="1" cellpadding="3"
590       cellspacing="0" width="100%" bgcolor="white">
591<tr><td>
592  <table width="100%" cellpadding="0" cellspacing="0" border="0">
593  <tr valign="top"><td>
594  <h3 class="epydoc"><span class="sig"><span class="sig-name">prev</span>(<span class="sig-arg">self</span>,
595        <span class="sig-arg">step</span>=<span class="sig-default">1</span>)</span>
596  </h3>
597  </td><td align="right" valign="top"
598    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.prev">source&nbsp;code</a></span>&nbsp;
599    </td>
600  </tr></table>
601  
602  Step backwards in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.
603Returns <code class="link">self</code> if a boundary is reached.
604  <dl class="fields">
605  </dl>
606</td></tr></table>
607</div>
608<a name="next"></a>
609<div>
610<table class="details" border="1" cellpadding="3"
611       cellspacing="0" width="100%" bgcolor="white">
612<tr><td>
613  <table width="100%" cellpadding="0" cellspacing="0" border="0">
614  <tr valign="top"><td>
615  <h3 class="epydoc"><span class="sig"><span class="sig-name">next</span>(<span class="sig-arg">self</span>,
616        <span class="sig-arg">step</span>=<span class="sig-default">1</span>)</span>
617  </h3>
618  </td><td align="right" valign="top"
619    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.next">source&nbsp;code</a></span>&nbsp;
620    </td>
621  </tr></table>
622  
623  Step forward in the containing <a href="echonest.audio.AudioQuantumList-class.html" class="link">AudioQuantumList</a>.
624Returns <code class="link">self</code> if a boundary is reached.
625  <dl class="fields">
626  </dl>
627</td></tr></table>
628</div>
629<a name="__str__"></a>
630<div>
631<table class="details" border="1" cellpadding="3"
632       cellspacing="0" width="100%" bgcolor="white">
633<tr><td>
634  <table width="100%" cellpadding="0" cellspacing="0" border="0">
635  <tr valign="top"><td>
636  <h3 class="epydoc"><span class="sig"><span class="sig-name">__str__</span>(<span class="sig-arg">self</span>)</span>
637    <br /><em class="fname">(Informal representation operator)</em>
638  </h3>
639  </td><td align="right" valign="top"
640    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__str__">source&nbsp;code</a></span>&nbsp;
641    </td>
642  </tr></table>
643  
644  <p>Lists the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.kind with start and
645end times, in seconds, e.g.:</p>
646<pre class="rst-literal-block">
647&quot;segment (20.31 - 20.42)&quot;
648</pre>
649  <dl class="fields">
650    <dt>Overrides:
651        object.__str__
652    </dt>
653  </dl>
654</td></tr></table>
655</div>
656<a name="__repr__"></a>
657<div>
658<table class="details" border="1" cellpadding="3"
659       cellspacing="0" width="100%" bgcolor="white">
660<tr><td>
661  <table width="100%" cellpadding="0" cellspacing="0" border="0">
662  <tr valign="top"><td>
663  <h3 class="epydoc"><span class="sig"><span class="sig-name">__repr__</span>(<span class="sig-arg">self</span>)</span>
664    <br /><em class="fname">(Representation operator)</em>
665  </h3>
666  </td><td align="right" valign="top"
667    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.__repr__">source&nbsp;code</a></span>&nbsp;
668    </td>
669  </tr></table>
670  
671  <p>A string representing a constructor, including kind, start time,
672duration, and (if it exists) confidence, e.g.:</p>
673<pre class="rst-literal-block">
674&quot;AudioQuantum(kind='tatum', start=42.198267, duration=0.1523394)&quot;
675</pre>
676  <dl class="fields">
677    <dt>Overrides:
678        object.__repr__
679    </dt>
680  </dl>
681</td></tr></table>
682</div>
683<a name="context_string"></a>
684<div>
685<table class="details" border="1" cellpadding="3"
686       cellspacing="0" width="100%" bgcolor="white">
687<tr><td>
688  <table width="100%" cellpadding="0" cellspacing="0" border="0">
689  <tr valign="top"><td>
690  <h3 class="epydoc"><span class="sig"><span class="sig-name">context_string</span>(<span class="sig-arg">self</span>)</span>
691  </h3>
692  </td><td align="right" valign="top"
693    ><span class="codelink"><a href="echonest.audio-pysrc.html#AudioQuantum.context_string">source&nbsp;code</a></span>&nbsp;
694    </td>
695  </tr></table>
696  
697  <p>Returns a one-indexed, human-readable version of context.
698For example:</p>
699<pre class="rst-literal-block">
700&quot;bar 4 of 142, beat 3 of 4, tatum 2 of 3&quot;
701</pre>
702  <dl class="fields">
703  </dl>
704</td></tr></table>
705</div>
706<br />
707<!-- ==================== PROPERTY DETAILS ==================== -->
708<a name="section-PropertyDetails"></a>
709<table class="details" border="1" cellpadding="3"
710       cellspacing="0" width="100%" bgcolor="white">
711<tr bgcolor="#70b0f0" class="table-header">
712  <td colspan="2" class="table-header">
713    <table border="0" cellpadding="0" cellspacing="0" width="100%">
714      <tr valign="top">
715        <td align="left"><span class="table-header">Property Details</span></td>
716        <td align="right" valign="top"
717         ><span class="options">[<a href="#section-PropertyDetails"
718         class="privatelink" onclick="toggle_private();"
719         >hide private</a>]</span></td>
720      </tr>
721    </table>
722  </td>
723</tr>
724</table>
725<a name="end"></a>
726<div>
727<table class="details" border="1" cellpadding="3"
728       cellspacing="0" width="100%" bgcolor="white">
729<tr><td>
730  <h3 class="epydoc">end</h3>
731  A computed property: the sum of <code class="link">start</code> and <code class="link">duration</code>.
732  <dl class="fields">
733    <dt>Get Method:</dt>
734    <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>
735    </dd>
736  </dl>
737</td></tr></table>
738</div>
739<a name="source"></a>
740<div>
741<table class="details" border="1" cellpadding="3"
742       cellspacing="0" width="100%" bgcolor="white">
743<tr><td>
744  <h3 class="epydoc">source</h3>
745  The <a href="echonest.audio.AudioData-class.html" class="link">AudioData</a> source for the AudioQuantum.
746  <dl class="fields">
747    <dt>Get Method:</dt>
748    <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>
749        - Returns itself or its parent.
750    </dd>
751    <dt>Set Method:</dt>
752    <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>,
753        <span class="summary-sig-arg">value</span>)</span>
754    </dd>
755  </dl>
756</td></tr></table>
757</div>
758<br />
759<!-- ==================== NAVIGATION BAR ==================== -->
760<table class="navbar" border="0" width="100%" cellpadding="0"
761       bgcolor="#a0c0ff" cellspacing="0">
762  <tr valign="middle">
763
764  <!-- Tree link -->
765      <th>&nbsp;&nbsp;&nbsp;<a
766        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
767
768  <!-- Index link -->
769      <th>&nbsp;&nbsp;&nbsp;<a
770        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
771
772  <!-- Help link -->
773      <th>&nbsp;&nbsp;&nbsp;<a
774        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
775
776  <!-- Project homepage -->
777      <th class="navbar" align="right" width="100%">
778        <table border="0" cellpadding="0" cellspacing="0">
779          <tr><th class="navbar" align="center"
780            ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
781          </tr></table></th>
782  </tr>
783</table>
784<table border="0" cellpadding="0" cellspacing="0" width="100%%">
785  <tr>
786    <td align="left" class="footer">
787    Generated by Epydoc 3.0.1 on Wed Sep  1 16:08:58 2010
788    </td>
789    <td align="right" class="footer">
790      <a target="mainFrame" href="http://epydoc.sourceforge.net"
791        >http://epydoc.sourceforge.net</a>
792    </td>
793  </tr>
794</table>
795
796<script type="text/javascript">
797  <!--
798  // Private objects are initially displayed (because if
799  // javascript is turned off then we want them to be
800  // visible); but by default, we want to hide them.  So hide
801  // them unless we have a cookie that says to show them.
802  checkCookie();
803  // -->
804</script>
805</body>
806</html>