/apidocs/echonest.sorting-module.html

http://echo-nest-remix.googlecode.com/ · HTML · 456 lines · 401 code · 33 blank · 22 comment · 0 complexity · 08941048d12bf020cf284429e7292940 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.sorting</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. Module&nbsp;sorting
  39. </span>
  40. </td>
  41. <td>
  42. <table cellpadding="0" cellspacing="0">
  43. <!-- hide/show private -->
  44. <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
  45. onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
  46. <tr><td align="right"><span class="options"
  47. >[<a href="frames.html" target="_top">frames</a
  48. >]&nbsp;|&nbsp;<a href="echonest.sorting-module.html"
  49. target="_top">no&nbsp;frames</a>]</span></td></tr>
  50. </table>
  51. </td>
  52. </tr>
  53. </table>
  54. <!-- ==================== MODULE DESCRIPTION ==================== -->
  55. <h1 class="epydoc">Module sorting</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.sorting-pysrc.html">source&nbsp;code</a></span></p>
  56. <p>Sorting key functions as utilities for <a href="echonest.audio-module.html" class="link">echonest.audio</a>.</p>
  57. <p>For convenience, intended to be imported as:</p>
  58. <pre class="rst-literal-block">
  59. from audio.sorting import *
  60. </pre>
  61. <p>All of the functions in this module can be used as a sorting key for
  62. <code class="link">AudioQuantumList.ordered_by</code>, as in:</p>
  63. <pre class="rst-literal-block">
  64. analysis.segments.ordered_by(duration)
  65. </pre>
  66. <p>Some of the functions in this module return <em>another</em> function that takes
  67. one argument, an <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>, and returns a value (typically a <code class="link">float</code>)
  68. that can then be used as a sorting value.</p>
  69. <p>By convention, all of these functions are named to be noun phrases that
  70. follow <code class="link">sorted_by</code>, as seen above.</p>
  71. <!-- ==================== FUNCTIONS ==================== -->
  72. <a name="section-Functions"></a>
  73. <table class="summary" border="1" cellpadding="3"
  74. cellspacing="0" width="100%" bgcolor="white">
  75. <tr bgcolor="#70b0f0" class="table-header">
  76. <td colspan="2" class="table-header">
  77. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  78. <tr valign="top">
  79. <td align="left"><span class="table-header">Functions</span></td>
  80. <td align="right" valign="top"
  81. ><span class="options">[<a href="#section-Functions"
  82. class="privatelink" onclick="toggle_private();"
  83. >hide private</a>]</span></td>
  84. </tr>
  85. </table>
  86. </td>
  87. </tr>
  88. <tr>
  89. <td width="15%" align="right" valign="top" class="summary">
  90. <span class="summary-type">&nbsp;</span>
  91. </td><td class="summary">
  92. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  93. <tr>
  94. <td><span class="summary-sig"><a name="confidence"></a><span class="summary-sig-name">confidence</span>(<span class="summary-sig-arg">x</span>)</span><br />
  95. Returns the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>'s <a href="echonest.sorting-module.html#confidence" class="link">confidence</a> as a sorting value.</td>
  96. <td align="right" valign="top">
  97. <span class="codelink"><a href="echonest.sorting-pysrc.html#confidence">source&nbsp;code</a></span>
  98. </td>
  99. </tr>
  100. </table>
  101. </td>
  102. </tr>
  103. <tr>
  104. <td width="15%" align="right" valign="top" class="summary">
  105. <span class="summary-type">&nbsp;</span>
  106. </td><td class="summary">
  107. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  108. <tr>
  109. <td><span class="summary-sig"><a name="duration"></a><span class="summary-sig-name">duration</span>(<span class="summary-sig-arg">x</span>)</span><br />
  110. Returns the <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>'s <a href="echonest.sorting-module.html#duration" class="link">duration</a> as a sorting value.</td>
  111. <td align="right" valign="top">
  112. <span class="codelink"><a href="echonest.sorting-pysrc.html#duration">source&nbsp;code</a></span>
  113. </td>
  114. </tr>
  115. </table>
  116. </td>
  117. </tr>
  118. <tr>
  119. <td width="15%" align="right" valign="top" class="summary">
  120. <span class="summary-type">&nbsp;</span>
  121. </td><td class="summary">
  122. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  123. <tr>
  124. <td><span class="summary-sig"><a href="echonest.sorting-module.html#timbre_value" class="summary-sig-name">timbre_value</a>(<span class="summary-sig-arg">index</span>)</span><br />
  125. Returns a function that returns the value of <code class="link">timbre</code>[<em>index</em>]
  126. of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
  127. <td align="right" valign="top">
  128. <span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_value">source&nbsp;code</a></span>
  129. </td>
  130. </tr>
  131. </table>
  132. </td>
  133. </tr>
  134. <tr>
  135. <td width="15%" align="right" valign="top" class="summary">
  136. <span class="summary-type">&nbsp;</span>
  137. </td><td class="summary">
  138. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  139. <tr>
  140. <td><span class="summary-sig"><a href="echonest.sorting-module.html#pitch_value" class="summary-sig-name">pitch_value</a>(<span class="summary-sig-arg">index</span>)</span><br />
  141. Returns a function that returns the value of <code class="link">pitch</code>[<em>index</em>]
  142. of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
  143. <td align="right" valign="top">
  144. <span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_value">source&nbsp;code</a></span>
  145. </td>
  146. </tr>
  147. </table>
  148. </td>
  149. </tr>
  150. <tr>
  151. <td width="15%" align="right" valign="top" class="summary">
  152. <span class="summary-type">&nbsp;</span>
  153. </td><td class="summary">
  154. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  155. <tr>
  156. <td><span class="summary-sig"><a href="echonest.sorting-module.html#pitch_distance_from" class="summary-sig-name">pitch_distance_from</a>(<span class="summary-sig-arg">seg</span>)</span><br />
  157. Returns a function that returns the sum of the squared differences
  158. between the <code class="link">pitch</code> vector of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> and the <code class="link">pitch</code>
  159. vector of the reference parameter <em>seg</em>.</td>
  160. <td align="right" valign="top">
  161. <span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_distance_from">source&nbsp;code</a></span>
  162. </td>
  163. </tr>
  164. </table>
  165. </td>
  166. </tr>
  167. <tr>
  168. <td width="15%" align="right" valign="top" class="summary">
  169. <span class="summary-type">&nbsp;</span>
  170. </td><td class="summary">
  171. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  172. <tr>
  173. <td><span class="summary-sig"><a href="echonest.sorting-module.html#timbre_distance_from" class="summary-sig-name">timbre_distance_from</a>(<span class="summary-sig-arg">seg</span>)</span><br />
  174. Returns a function that returns the sum of the squared differences
  175. between the <code class="link">pitch</code> vector of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> and the <code class="link">pitch</code>
  176. vector of the reference parameter <em>seg</em>.</td>
  177. <td align="right" valign="top">
  178. <span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_distance_from">source&nbsp;code</a></span>
  179. </td>
  180. </tr>
  181. </table>
  182. </td>
  183. </tr>
  184. <tr>
  185. <td width="15%" align="right" valign="top" class="summary">
  186. <span class="summary-type">&nbsp;</span>
  187. </td><td class="summary">
  188. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  189. <tr>
  190. <td><span class="summary-sig"><a href="echonest.sorting-module.html#noisiness" class="summary-sig-name">noisiness</a>(<span class="summary-sig-arg">x</span>)</span><br />
  191. Returns the sum of the twelve pitch vectors' elements.</td>
  192. <td align="right" valign="top">
  193. <span class="codelink"><a href="echonest.sorting-pysrc.html#noisiness">source&nbsp;code</a></span>
  194. </td>
  195. </tr>
  196. </table>
  197. </td>
  198. </tr>
  199. <tr class="private">
  200. <td width="15%" align="right" valign="top" class="summary">
  201. <span class="summary-type">&nbsp;</span>
  202. </td><td class="summary">
  203. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  204. <tr>
  205. <td><span class="summary-sig"><a href="echonest.sorting-module.html#_diff_squared" class="summary-sig-name" onclick="show_private();">_diff_squared</a>(<span class="summary-sig-arg">a</span>,
  206. <span class="summary-sig-arg">b</span>)</span><br />
  207. Local helper function.</td>
  208. <td align="right" valign="top">
  209. <span class="codelink"><a href="echonest.sorting-pysrc.html#_diff_squared">source&nbsp;code</a></span>
  210. </td>
  211. </tr>
  212. </table>
  213. </td>
  214. </tr>
  215. </table>
  216. <!-- ==================== VARIABLES ==================== -->
  217. <a name="section-Variables"></a>
  218. <table class="summary" border="1" cellpadding="3"
  219. cellspacing="0" width="100%" bgcolor="white">
  220. <tr bgcolor="#70b0f0" class="table-header">
  221. <td colspan="2" class="table-header">
  222. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  223. <tr valign="top">
  224. <td align="left"><span class="table-header">Variables</span></td>
  225. <td align="right" valign="top"
  226. ><span class="options">[<a href="#section-Variables"
  227. class="privatelink" onclick="toggle_private();"
  228. >hide private</a>]</span></td>
  229. </tr>
  230. </table>
  231. </td>
  232. </tr>
  233. <tr>
  234. <td width="15%" align="right" valign="top" class="summary">
  235. <span class="summary-type">&nbsp;</span>
  236. </td><td class="summary">
  237. <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
  238. hash(x)
  239. </td>
  240. </tr>
  241. </table>
  242. <!-- ==================== FUNCTION DETAILS ==================== -->
  243. <a name="section-FunctionDetails"></a>
  244. <table class="details" border="1" cellpadding="3"
  245. cellspacing="0" width="100%" bgcolor="white">
  246. <tr bgcolor="#70b0f0" class="table-header">
  247. <td colspan="2" class="table-header">
  248. <table border="0" cellpadding="0" cellspacing="0" width="100%">
  249. <tr valign="top">
  250. <td align="left"><span class="table-header">Function Details</span></td>
  251. <td align="right" valign="top"
  252. ><span class="options">[<a href="#section-FunctionDetails"
  253. class="privatelink" onclick="toggle_private();"
  254. >hide private</a>]</span></td>
  255. </tr>
  256. </table>
  257. </td>
  258. </tr>
  259. </table>
  260. <a name="timbre_value"></a>
  261. <div>
  262. <table class="details" border="1" cellpadding="3"
  263. cellspacing="0" width="100%" bgcolor="white">
  264. <tr><td>
  265. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  266. <tr valign="top"><td>
  267. <h3 class="epydoc"><span class="sig"><span class="sig-name">timbre_value</span>(<span class="sig-arg">index</span>)</span>
  268. </h3>
  269. </td><td align="right" valign="top"
  270. ><span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_value">source&nbsp;code</a></span>&nbsp;
  271. </td>
  272. </tr></table>
  273. Returns a function that returns the value of <code class="link">timbre</code>[<em>index</em>]
  274. of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>. Sorts by the values of the <em>index</em>-th
  275. value in the timbre vector.
  276. <dl class="fields">
  277. </dl>
  278. </td></tr></table>
  279. </div>
  280. <a name="pitch_value"></a>
  281. <div>
  282. <table class="details" border="1" cellpadding="3"
  283. cellspacing="0" width="100%" bgcolor="white">
  284. <tr><td>
  285. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  286. <tr valign="top"><td>
  287. <h3 class="epydoc"><span class="sig"><span class="sig-name">pitch_value</span>(<span class="sig-arg">index</span>)</span>
  288. </h3>
  289. </td><td align="right" valign="top"
  290. ><span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_value">source&nbsp;code</a></span>&nbsp;
  291. </td>
  292. </tr></table>
  293. Returns a function that returns the value of <code class="link">pitch</code>[<em>index</em>]
  294. of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>. Sorts by the values of the <em>index</em>-th
  295. value in the pitch vector.
  296. <dl class="fields">
  297. </dl>
  298. </td></tr></table>
  299. </div>
  300. <a name="pitch_distance_from"></a>
  301. <div>
  302. <table class="details" border="1" cellpadding="3"
  303. cellspacing="0" width="100%" bgcolor="white">
  304. <tr><td>
  305. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  306. <tr valign="top"><td>
  307. <h3 class="epydoc"><span class="sig"><span class="sig-name">pitch_distance_from</span>(<span class="sig-arg">seg</span>)</span>
  308. </h3>
  309. </td><td align="right" valign="top"
  310. ><span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_distance_from">source&nbsp;code</a></span>&nbsp;
  311. </td>
  312. </tr></table>
  313. Returns a function that returns the sum of the squared differences
  314. between the <code class="link">pitch</code> vector of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> and the <code class="link">pitch</code>
  315. vector of the reference parameter <em>seg</em>. Sorts by the pitch distance
  316. from the reference <a href="echonest.audio.AudioSegment-class.html" class="link">AudioSegment</a>.
  317. <dl class="fields">
  318. </dl>
  319. </td></tr></table>
  320. </div>
  321. <a name="timbre_distance_from"></a>
  322. <div>
  323. <table class="details" border="1" cellpadding="3"
  324. cellspacing="0" width="100%" bgcolor="white">
  325. <tr><td>
  326. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  327. <tr valign="top"><td>
  328. <h3 class="epydoc"><span class="sig"><span class="sig-name">timbre_distance_from</span>(<span class="sig-arg">seg</span>)</span>
  329. </h3>
  330. </td><td align="right" valign="top"
  331. ><span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_distance_from">source&nbsp;code</a></span>&nbsp;
  332. </td>
  333. </tr></table>
  334. Returns a function that returns the sum of the squared differences
  335. between the <code class="link">pitch</code> vector of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a> and the <code class="link">pitch</code>
  336. vector of the reference parameter <em>seg</em>. Sorts by the pitch distance
  337. from the reference <a href="echonest.audio.AudioSegment-class.html" class="link">AudioSegment</a>.
  338. <dl class="fields">
  339. </dl>
  340. </td></tr></table>
  341. </div>
  342. <a name="noisiness"></a>
  343. <div>
  344. <table class="details" border="1" cellpadding="3"
  345. cellspacing="0" width="100%" bgcolor="white">
  346. <tr><td>
  347. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  348. <tr valign="top"><td>
  349. <h3 class="epydoc"><span class="sig"><span class="sig-name">noisiness</span>(<span class="sig-arg">x</span>)</span>
  350. </h3>
  351. </td><td align="right" valign="top"
  352. ><span class="codelink"><a href="echonest.sorting-pysrc.html#noisiness">source&nbsp;code</a></span>&nbsp;
  353. </td>
  354. </tr></table>
  355. Returns the sum of the twelve pitch vectors' elements. This is a very
  356. fast way of judging the relative noisiness of a segment.
  357. <dl class="fields">
  358. </dl>
  359. </td></tr></table>
  360. </div>
  361. <a name="_diff_squared"></a>
  362. <div class="private">
  363. <table class="details" border="1" cellpadding="3"
  364. cellspacing="0" width="100%" bgcolor="white">
  365. <tr><td>
  366. <table width="100%" cellpadding="0" cellspacing="0" border="0">
  367. <tr valign="top"><td>
  368. <h3 class="epydoc"><span class="sig"><span class="sig-name">_diff_squared</span>(<span class="sig-arg">a</span>,
  369. <span class="sig-arg">b</span>)</span>
  370. </h3>
  371. </td><td align="right" valign="top"
  372. ><span class="codelink"><a href="echonest.sorting-pysrc.html#_diff_squared">source&nbsp;code</a></span>&nbsp;
  373. </td>
  374. </tr></table>
  375. Local helper function. The square of the difference between a and b.
  376. <dl class="fields">
  377. </dl>
  378. </td></tr></table>
  379. </div>
  380. <br />
  381. <!-- ==================== NAVIGATION BAR ==================== -->
  382. <table class="navbar" border="0" width="100%" cellpadding="0"
  383. bgcolor="#a0c0ff" cellspacing="0">
  384. <tr valign="middle">
  385. <!-- Tree link -->
  386. <th>&nbsp;&nbsp;&nbsp;<a
  387. href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  388. <!-- Index link -->
  389. <th>&nbsp;&nbsp;&nbsp;<a
  390. href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
  391. <!-- Help link -->
  392. <th>&nbsp;&nbsp;&nbsp;<a
  393. href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
  394. <!-- Project homepage -->
  395. <th class="navbar" align="right" width="100%">
  396. <table border="0" cellpadding="0" cellspacing="0">
  397. <tr><th class="navbar" align="center"
  398. ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
  399. </tr></table></th>
  400. </tr>
  401. </table>
  402. <table border="0" cellpadding="0" cellspacing="0" width="100%%">
  403. <tr>
  404. <td align="left" class="footer">
  405. Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
  406. </td>
  407. <td align="right" class="footer">
  408. <a target="mainFrame" href="http://epydoc.sourceforge.net"
  409. >http://epydoc.sourceforge.net</a>
  410. </td>
  411. </tr>
  412. </table>
  413. <script type="text/javascript">
  414. <!--
  415. // Private objects are initially displayed (because if
  416. // javascript is turned off then we want them to be
  417. // visible); but by default, we want to hide them. So hide
  418. // them unless we have a cookie that says to show them.
  419. checkCookie();
  420. // -->
  421. </script>
  422. </body>
  423. </html>