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