/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
- <?xml version="1.0" encoding="ascii"?>
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <title>echonest.sorting</title>
- <link rel="stylesheet" href="epydoc.css" type="text/css" />
- <script type="text/javascript" src="epydoc.js"></script>
- </head>
- <body bgcolor="white" text="black" link="blue" vlink="#204080"
- alink="#204080">
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table width="100%" cellpadding="0" cellspacing="0">
- <tr valign="top">
- <td width="100%">
- <span class="breadcrumbs">
- <a href="echonest-module.html">Package echonest</a> ::
- Module sorting
- </span>
- </td>
- <td>
- <table cellpadding="0" cellspacing="0">
- <!-- hide/show private -->
- <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
- onclick="toggle_private();">hide private</a>]</span></td></tr>
- <tr><td align="right"><span class="options"
- >[<a href="frames.html" target="_top">frames</a
- >] | <a href="echonest.sorting-module.html"
- target="_top">no frames</a>]</span></td></tr>
- </table>
- </td>
- </tr>
- </table>
- <!-- ==================== MODULE DESCRIPTION ==================== -->
- <h1 class="epydoc">Module sorting</h1><p class="nomargin-top"><span class="codelink"><a href="echonest.sorting-pysrc.html">source code</a></span></p>
- <p>Sorting key functions as utilities for <a href="echonest.audio-module.html" class="link">echonest.audio</a>.</p>
- <p>For convenience, intended to be imported as:</p>
- <pre class="rst-literal-block">
- from audio.sorting import *
- </pre>
- <p>All of the functions in this module can be used as a sorting key for
- <code class="link">AudioQuantumList.ordered_by</code>, as in:</p>
- <pre class="rst-literal-block">
- analysis.segments.ordered_by(duration)
- </pre>
- <p>Some of the functions in this module return <em>another</em> function that takes
- 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>)
- that can then be used as a sorting value.</p>
- <p>By convention, all of these functions are named to be noun phrases that
- follow <code class="link">sorted_by</code>, as seen above.</p>
- <!-- ==================== FUNCTIONS ==================== -->
- <a name="section-Functions"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Functions</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Functions"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="confidence"></a><span class="summary-sig-name">confidence</span>(<span class="summary-sig-arg">x</span>)</span><br />
- 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>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#confidence">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="duration"></a><span class="summary-sig-name">duration</span>(<span class="summary-sig-arg">x</span>)</span><br />
- 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>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#duration">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#timbre_value" class="summary-sig-name">timbre_value</a>(<span class="summary-sig-arg">index</span>)</span><br />
- Returns a function that returns the value of <code class="link">timbre</code>[<em>index</em>]
- of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_value">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#pitch_value" class="summary-sig-name">pitch_value</a>(<span class="summary-sig-arg">index</span>)</span><br />
- Returns a function that returns the value of <code class="link">pitch</code>[<em>index</em>]
- of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_value">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#pitch_distance_from" class="summary-sig-name">pitch_distance_from</a>(<span class="summary-sig-arg">seg</span>)</span><br />
- Returns a function that returns the sum of the squared differences
- 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>
- vector of the reference parameter <em>seg</em>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_distance_from">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#timbre_distance_from" class="summary-sig-name">timbre_distance_from</a>(<span class="summary-sig-arg">seg</span>)</span><br />
- Returns a function that returns the sum of the squared differences
- 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>
- vector of the reference parameter <em>seg</em>.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_distance_from">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#noisiness" class="summary-sig-name">noisiness</a>(<span class="summary-sig-arg">x</span>)</span><br />
- Returns the sum of the twelve pitch vectors' elements.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#noisiness">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- <tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a href="echonest.sorting-module.html#_diff_squared" class="summary-sig-name" onclick="show_private();">_diff_squared</a>(<span class="summary-sig-arg">a</span>,
- <span class="summary-sig-arg">b</span>)</span><br />
- Local helper function.</td>
- <td align="right" valign="top">
- <span class="codelink"><a href="echonest.sorting-pysrc.html#_diff_squared">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
- </table>
- <!-- ==================== VARIABLES ==================== -->
- <a name="section-Variables"></a>
- <table class="summary" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Variables</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-Variables"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- <tr>
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="None">None</code><br />
- hash(x)
- </td>
- </tr>
- </table>
- <!-- ==================== FUNCTION DETAILS ==================== -->
- <a name="section-FunctionDetails"></a>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr bgcolor="#70b0f0" class="table-header">
- <td colspan="2" class="table-header">
- <table border="0" cellpadding="0" cellspacing="0" width="100%">
- <tr valign="top">
- <td align="left"><span class="table-header">Function Details</span></td>
- <td align="right" valign="top"
- ><span class="options">[<a href="#section-FunctionDetails"
- class="privatelink" onclick="toggle_private();"
- >hide private</a>]</span></td>
- </tr>
- </table>
- </td>
- </tr>
- </table>
- <a name="timbre_value"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">timbre_value</span>(<span class="sig-arg">index</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_value">source code</a></span>
- </td>
- </tr></table>
-
- Returns a function that returns the value of <code class="link">timbre</code>[<em>index</em>]
- of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>. Sorts by the values of the <em>index</em>-th
- value in the timbre vector.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="pitch_value"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">pitch_value</span>(<span class="sig-arg">index</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_value">source code</a></span>
- </td>
- </tr></table>
-
- Returns a function that returns the value of <code class="link">pitch</code>[<em>index</em>]
- of its input <a href="echonest.audio.AudioQuantum-class.html" class="link">AudioQuantum</a>. Sorts by the values of the <em>index</em>-th
- value in the pitch vector.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="pitch_distance_from"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">pitch_distance_from</span>(<span class="sig-arg">seg</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#pitch_distance_from">source code</a></span>
- </td>
- </tr></table>
-
- Returns a function that returns the sum of the squared differences
- 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>
- vector of the reference parameter <em>seg</em>. Sorts by the pitch distance
- from the reference <a href="echonest.audio.AudioSegment-class.html" class="link">AudioSegment</a>.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="timbre_distance_from"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">timbre_distance_from</span>(<span class="sig-arg">seg</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#timbre_distance_from">source code</a></span>
- </td>
- </tr></table>
-
- Returns a function that returns the sum of the squared differences
- 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>
- vector of the reference parameter <em>seg</em>. Sorts by the pitch distance
- from the reference <a href="echonest.audio.AudioSegment-class.html" class="link">AudioSegment</a>.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="noisiness"></a>
- <div>
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">noisiness</span>(<span class="sig-arg">x</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#noisiness">source code</a></span>
- </td>
- </tr></table>
-
- Returns the sum of the twelve pitch vectors' elements. This is a very
- fast way of judging the relative noisiness of a segment.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <a name="_diff_squared"></a>
- <div class="private">
- <table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
- <tr><td>
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr valign="top"><td>
- <h3 class="epydoc"><span class="sig"><span class="sig-name">_diff_squared</span>(<span class="sig-arg">a</span>,
- <span class="sig-arg">b</span>)</span>
- </h3>
- </td><td align="right" valign="top"
- ><span class="codelink"><a href="echonest.sorting-pysrc.html#_diff_squared">source code</a></span>
- </td>
- </tr></table>
-
- Local helper function. The square of the difference between a and b.
- <dl class="fields">
- </dl>
- </td></tr></table>
- </div>
- <br />
- <!-- ==================== NAVIGATION BAR ==================== -->
- <table class="navbar" border="0" width="100%" cellpadding="0"
- bgcolor="#a0c0ff" cellspacing="0">
- <tr valign="middle">
- <!-- Tree link -->
- <th> <a
- href="module-tree.html">Trees</a> </th>
- <!-- Index link -->
- <th> <a
- href="identifier-index.html">Indices</a> </th>
- <!-- Help link -->
- <th> <a
- href="help.html">Help</a> </th>
- <!-- Project homepage -->
- <th class="navbar" align="right" width="100%">
- <table border="0" cellpadding="0" cellspacing="0">
- <tr><th class="navbar" align="center"
- ><a class="navbar" target="_top" href="http://code.google.com/p/echo-nest-remix/">Project Homepage</a></th>
- </tr></table></th>
- </tr>
- </table>
- <table border="0" cellpadding="0" cellspacing="0" width="100%%">
- <tr>
- <td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Wed Sep 1 16:08:57 2010
- </td>
- <td align="right" class="footer">
- <a target="mainFrame" href="http://epydoc.sourceforge.net"
- >http://epydoc.sourceforge.net</a>
- </td>
- </tr>
- </table>
- <script type="text/javascript">
- <!--
- // Private objects are initially displayed (because if
- // javascript is turned off then we want them to be
- // visible); but by default, we want to hide them. So hide
- // them unless we have a cookie that says to show them.
- checkCookie();
- // -->
- </script>
- </body>
- </html>