This repository has been archived by the owner on Feb 18, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
effects.html
263 lines (242 loc) · 14.7 KB
/
effects.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Effects — librosa 0.9.1 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/plot_directive.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-binder.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-dataframe.css" type="text/css" />
<link rel="stylesheet" href="_static/sg_gallery-rendered-html.css" type="text/css" />
<link rel="stylesheet" href="_static/css/custom.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="librosa.effects.hpss" href="generated/librosa.effects.hpss.html" />
<link rel="prev" title="librosa.decompose.nn_filter" href="generated/librosa.decompose.nn_filter.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" style="background: white" >
<a href="index.html">
<img src="_static/librosa_logo_text.svg" class="logo" alt="Logo"/>
</a>
<div class="version">
0.9.1
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation instructions</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting.html">Troubleshooting</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API documentation</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="core.html">Core IO and DSP</a></li>
<li class="toctree-l1"><a class="reference internal" href="display.html">Display</a></li>
<li class="toctree-l1"><a class="reference internal" href="feature.html">Feature extraction</a></li>
<li class="toctree-l1"><a class="reference internal" href="onset.html">Onset detection</a></li>
<li class="toctree-l1"><a class="reference internal" href="beat.html">Beat and tempo</a></li>
<li class="toctree-l1"><a class="reference internal" href="decompose.html">Spectrogram decomposition</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Effects</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#harmonic-percussive-source-separation">Harmonic-percussive source separation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.hpss.html">librosa.effects.hpss</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.harmonic.html">librosa.effects.harmonic</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.percussive.html">librosa.effects.percussive</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#time-and-frequency">Time and frequency</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.time_stretch.html">librosa.effects.time_stretch</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.pitch_shift.html">librosa.effects.pitch_shift</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#miscellaneous">Miscellaneous</a><ul>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.remix.html">librosa.effects.remix</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.trim.html">librosa.effects.trim</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.split.html">librosa.effects.split</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.preemphasis.html">librosa.effects.preemphasis</a></li>
<li class="toctree-l3"><a class="reference internal" href="generated/librosa.effects.deemphasis.html">librosa.effects.deemphasis</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="segment.html">Temporal segmentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="sequence.html">Sequential modeling</a></li>
<li class="toctree-l1"><a class="reference internal" href="util.html">Utilities</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Advanced topics</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="multichannel.html">Multi-channel</a></li>
<li class="toctree-l1"><a class="reference internal" href="filters.html">Filters</a></li>
<li class="toctree-l1"><a class="reference internal" href="cache.html">Caching</a></li>
<li class="toctree-l1"><a class="reference internal" href="ioformats.html">Advanced I/O Use Cases</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced.html">Advanced examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="recordings.html">Example files</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary.html">Glossary</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" style="background: white" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">librosa</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Effects</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/effects.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<span class="target" id="module-librosa.effects"><span id="effects"></span></span><section id="id1">
<h1>Effects<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>
<section id="harmonic-percussive-source-separation">
<h2>Harmonic-percussive source separation<a class="headerlink" href="#harmonic-percussive-source-separation" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.hpss.html#librosa.effects.hpss" title="librosa.effects.hpss"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hpss</span></code></a>(y, **kwargs)</p></td>
<td><p>Decompose an audio time series into harmonic and percussive components.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/librosa.effects.harmonic.html#librosa.effects.harmonic" title="librosa.effects.harmonic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">harmonic</span></code></a>(y, **kwargs)</p></td>
<td><p>Extract harmonic elements from an audio time-series.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.percussive.html#librosa.effects.percussive" title="librosa.effects.percussive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">percussive</span></code></a>(y, **kwargs)</p></td>
<td><p>Extract percussive elements from an audio time-series.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="time-and-frequency">
<h2>Time and frequency<a class="headerlink" href="#time-and-frequency" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.time_stretch.html#librosa.effects.time_stretch" title="librosa.effects.time_stretch"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_stretch</span></code></a>(y, *, rate, **kwargs)</p></td>
<td><p>Time-stretch an audio series by a fixed rate.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/librosa.effects.pitch_shift.html#librosa.effects.pitch_shift" title="librosa.effects.pitch_shift"><code class="xref py py-obj docutils literal notranslate"><span class="pre">pitch_shift</span></code></a>(y, *, sr, n_steps[, ...])</p></td>
<td><p>Shift the pitch of a waveform by <code class="docutils literal notranslate"><span class="pre">n_steps</span></code> steps.</p></td>
</tr>
</tbody>
</table>
</section>
<section id="miscellaneous">
<h2>Miscellaneous<a class="headerlink" href="#miscellaneous" title="Permalink to this headline">¶</a></h2>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.remix.html#librosa.effects.remix" title="librosa.effects.remix"><code class="xref py py-obj docutils literal notranslate"><span class="pre">remix</span></code></a>(y, intervals, *[, align_zeros])</p></td>
<td><p>Remix an audio signal by re-ordering time intervals.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/librosa.effects.trim.html#librosa.effects.trim" title="librosa.effects.trim"><code class="xref py py-obj docutils literal notranslate"><span class="pre">trim</span></code></a>(y, *[, top_db, ref, frame_length, ...])</p></td>
<td><p>Trim leading and trailing silence from an audio signal.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.split.html#librosa.effects.split" title="librosa.effects.split"><code class="xref py py-obj docutils literal notranslate"><span class="pre">split</span></code></a>(y, *[, top_db, ref, frame_length, ...])</p></td>
<td><p>Split an audio signal into non-silent intervals.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="generated/librosa.effects.preemphasis.html#librosa.effects.preemphasis" title="librosa.effects.preemphasis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">preemphasis</span></code></a>(y, *[, coef, zi, return_zf])</p></td>
<td><p>Pre-emphasize an audio signal with a first-order auto-regressive filter:</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/librosa.effects.deemphasis.html#librosa.effects.deemphasis" title="librosa.effects.deemphasis"><code class="xref py py-obj docutils literal notranslate"><span class="pre">deemphasis</span></code></a>(y, *[, coef, zi, return_zf])</p></td>
<td><p>De-emphasize an audio signal with the inverse operation of preemphasis():</p></td>
</tr>
</tbody>
</table>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="generated/librosa.decompose.nn_filter.html" class="btn btn-neutral float-left" title="librosa.decompose.nn_filter" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="generated/librosa.effects.hpss.html" class="btn btn-neutral float-right" title="librosa.effects.hpss" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2013--2022, librosa development team.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Other Versions</span>
v: 0.9.1
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<dl>
<dt>Releases</dt>
<dd><a href="../0.7.2/effects.html">0.7.2</a></dd>
<dd><a href="../0.8.1/effects.html">0.8.1</a></dd>
<dd><a href="../0.9.0/effects.html">0.9.0</a></dd>
<dd><a href="effects.html">0.9.1</a></dd>
</dl>
<dl>
<dt>Development versions</dt>
<dd><a href="../main/effects.html">main</a></dd>
</dl>
</div>
</div><script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<!-- Theme Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-171031946-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-171031946-1', {
'anonymize_ip': false,
});
</script>
</body>
</html>