-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcore.html
3209 lines (2965 loc) · 288 KB
/
core.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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Core — nussl 1.0.0 documentation</title>
<script type="text/javascript" src="_static/js/modernizr.min.js"></script>
<script type="text/javascript" id="documentation_options" data-url_root="./" 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/language_data.js"></script>
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Datasets" href="datasets.html" />
<link rel="prev" title="API Documentation" href="api.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" >
<a href="index.html" class="icon icon-home"> nussl
</a>
<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="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="tutorials.html">Tutorials</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="examples/examples.html">Examples</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="recipes/recipes.html">Recipes</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="api.html">API Documentation</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Core</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#audiosignals">AudioSignals</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.masks">Masks</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.constants">Constants</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.efz_utils">External File Zoo</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.utils">General utilities</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.mixing">Mixing</a></li>
<li class="toctree-l3"><a class="reference internal" href="#module-nussl.core.play_utils">Playing and embedding audio</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="datasets.html">Datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="evaluation.html">Evaluation</a></li>
<li class="toctree-l2"><a class="reference internal" href="ml.html">Machine Learning</a></li>
<li class="toctree-l2"><a class="reference internal" href="separation.html">Separation algorithms</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="citation.html">Citing nussl</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="contributing.html">Contribution Guide</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">nussl</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="api.html">API Documentation</a> »</li>
<li>Core</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/core.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">
<style>
/* CSS overrides for sphinx_rtd_theme */
/* 24px margin */
.nbinput.nblast.container,
.nboutput.nblast.container {
margin-bottom: 19px; /* padding has already 5px */
}
/* ... except between code cells! */
.nblast.container + .nbinput.container {
margin-top: -19px;
}
.admonition > p:before {
margin-right: 4px; /* make room for the exclamation icon */
}
/* Fix math alignment, see https://github.com/rtfd/sphinx_rtd_theme/pull/686 */
.math {
text-align: unset;
}
</style>
<span class="target" id="module-nussl.core"></span><div class="section" id="core">
<h1>Core<a class="headerlink" href="#core" title="Permalink to this headline">¶</a></h1>
<div class="section" id="audiosignals">
<h2>AudioSignals<a class="headerlink" href="#audiosignals" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="nussl.core.AudioSignal">
<em class="property">class </em><code class="sig-prename descclassname">nussl.core.</code><code class="sig-name descname">AudioSignal</code><span class="sig-paren">(</span><em class="sig-param">path_to_input_file=None</em>, <em class="sig-param">audio_data_array=None</em>, <em class="sig-param">stft=None</em>, <em class="sig-param">label=None</em>, <em class="sig-param">sample_rate=None</em>, <em class="sig-param">stft_params=None</em>, <em class="sig-param">offset=0</em>, <em class="sig-param">duration=None</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal" title="Permalink to this definition">¶</a></dt>
<dd><p><strong>Overview</strong></p>
<p><a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> is the main entry and exit point for all source separation algorithms
in <em>nussl</em>. The <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> class is a general container for all things related to
audio data. It contains utilities for:</p>
<ul class="simple">
<li><p>Input and output from an array or from a file,</p></li>
<li><p>Time-series and frequency domain manipulation,</p></li>
<li><p>Plotting and visualizing,</p></li>
<li><p>Playing audio within a terminal or jupyter notebook,</p></li>
<li><p>Applying a mask to estimate signals</p></li>
</ul>
<p><strong>Attributes</strong></p>
<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="#nussl.core.AudioSignal.active_region_is_default" title="nussl.core.AudioSignal.active_region_is_default"><code class="xref py py-obj docutils literal notranslate"><span class="pre">active_region_is_default</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">audio_data</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.file_name" title="nussl.core.AudioSignal.file_name"><code class="xref py py-obj docutils literal notranslate"><span class="pre">file_name</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.freq_vector" title="nussl.core.AudioSignal.freq_vector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">freq_vector</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.has_data" title="nussl.core.AudioSignal.has_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">has_data</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.is_mono" title="nussl.core.AudioSignal.is_mono"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_mono</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.is_stereo" title="nussl.core.AudioSignal.is_stereo"><code class="xref py py-obj docutils literal notranslate"><span class="pre">is_stereo</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">bool</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.log_magnitude_spectrogram_data" title="nussl.core.AudioSignal.log_magnitude_spectrogram_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">log_magnitude_spectrogram_data</span></code></a></p></td>
<td><p>Returns a real valued <code class="docutils literal notranslate"><span class="pre">np.array</span></code> with log magnitude spectrogram data.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.magnitude_spectrogram_data" title="nussl.core.AudioSignal.magnitude_spectrogram_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">magnitude_spectrogram_data</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.num_channels" title="nussl.core.AudioSignal.num_channels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">num_channels</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.power_spectrogram_data" title="nussl.core.AudioSignal.power_spectrogram_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">power_spectrogram_data</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.sample_rate" title="nussl.core.AudioSignal.sample_rate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sample_rate</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.signal_duration" title="nussl.core.AudioSignal.signal_duration"><code class="xref py py-obj docutils literal notranslate"><span class="pre">signal_duration</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.signal_length" title="nussl.core.AudioSignal.signal_length"><code class="xref py py-obj docutils literal notranslate"><span class="pre">signal_length</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft_data</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.stft_length" title="nussl.core.AudioSignal.stft_length"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft_length</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">int</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.stft_params" title="nussl.core.AudioSignal.stft_params"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft_params</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">STFTParams</span></code></p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.time_bins_vector" title="nussl.core.AudioSignal.time_bins_vector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_bins_vector</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.time_vector" title="nussl.core.AudioSignal.time_vector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">time_vector</span></code></a></p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></p></td>
</tr>
</tbody>
</table>
<p><strong>Methods</strong></p>
<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="#nussl.core.AudioSignal.add" title="nussl.core.AudioSignal.add"><code class="xref py py-obj docutils literal notranslate"><span class="pre">add</span></code></a>(other)</p></td>
<td><p>Adds two audio signal objects.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.apply_gain" title="nussl.core.AudioSignal.apply_gain"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_gain</span></code></a>(value)</p></td>
<td><p>Apply a gain to <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.apply_mask" title="nussl.core.AudioSignal.apply_mask"><code class="xref py py-obj docutils literal notranslate"><span class="pre">apply_mask</span></code></a>(mask[, overwrite])</p></td>
<td><p>Applies the input mask to the time-frequency representation in this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object and returns a new <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with the mask applied.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.concat" title="nussl.core.AudioSignal.concat"><code class="xref py py-obj docutils literal notranslate"><span class="pre">concat</span></code></a>(other)</p></td>
<td><p>Concatenate two <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> objects (by concatenating <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code>).</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.crop_signal" title="nussl.core.AudioSignal.crop_signal"><code class="xref py py-obj docutils literal notranslate"><span class="pre">crop_signal</span></code></a>(before, after)</p></td>
<td><p>Get rid of samples before and after the signal on all channels.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.embed_audio" title="nussl.core.AudioSignal.embed_audio"><code class="xref py py-obj docutils literal notranslate"><span class="pre">embed_audio</span></code></a>([ext, display])</p></td>
<td><p>Embeds the audio signal into a notebook, using <cite>nussl.play_utils.embed_audio</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channel" title="nussl.core.AudioSignal.get_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_channel</span></code></a>(n)</p></td>
<td><p>Gets audio data of n-th channel from <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> as a 1D <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code> of shape <code class="docutils literal notranslate"><span class="pre">(n_samples,)</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channels" title="nussl.core.AudioSignal.get_channels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_channels</span></code></a>()</p></td>
<td><p>Generator that will loop through channels of <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_magnitude_spectrogram_channel" title="nussl.core.AudioSignal.get_magnitude_spectrogram_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_magnitude_spectrogram_channel</span></code></a>(n)</p></td>
<td><p>Returns the n-th channel from <code class="docutils literal notranslate"><span class="pre">self.magnitude_spectrogram_data</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_power_spectrogram_channel" title="nussl.core.AudioSignal.get_power_spectrogram_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_power_spectrogram_channel</span></code></a>(n)</p></td>
<td><p>Returns the n-th channel from <code class="docutils literal notranslate"><span class="pre">self.power_spectrogram_data</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channel" title="nussl.core.AudioSignal.get_stft_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_stft_channel</span></code></a>(n)</p></td>
<td><p>Returns STFT data of n-th channel from <code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code> as a 2D <code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channels" title="nussl.core.AudioSignal.get_stft_channels"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_stft_channels</span></code></a>()</p></td>
<td><p>Generator that will loop through channels of <code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.get_window" title="nussl.core.AudioSignal.get_window"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_window</span></code></a>(window_type, window_length)</p></td>
<td><p>Wrapper around scipy.signal.get_window so one can also get the popular sqrt-hann window.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.ipd_ild_features" title="nussl.core.AudioSignal.ipd_ild_features"><code class="xref py py-obj docutils literal notranslate"><span class="pre">ipd_ild_features</span></code></a>([ch_one, ch_two])</p></td>
<td><p>Computes interphase difference (IPD) and interlevel difference (ILD) for a stereo spectrogram.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.istft" title="nussl.core.AudioSignal.istft"><code class="xref py py-obj docutils literal notranslate"><span class="pre">istft</span></code></a>([window_length, hop_length, …])</p></td>
<td><p>Computes and returns the inverse Short Time Fourier Transform (iSTFT).</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_array" title="nussl.core.AudioSignal.load_audio_from_array"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_audio_from_array</span></code></a>(signal[, sample_rate])</p></td>
<td><p>Loads an audio signal from a <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_file" title="nussl.core.AudioSignal.load_audio_from_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_audio_from_file</span></code></a>(input_file_path, …)</p></td>
<td><p>Loads an audio signal into memory from a file on disc.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.make_audio_signal_from_channel" title="nussl.core.AudioSignal.make_audio_signal_from_channel"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_audio_signal_from_channel</span></code></a>(n)</p></td>
<td><p>Makes a new <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object from with data from channel <code class="docutils literal notranslate"><span class="pre">n</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.make_copy_with_audio_data" title="nussl.core.AudioSignal.make_copy_with_audio_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_copy_with_audio_data</span></code></a>(audio_data[, verbose])</p></td>
<td><p>Makes a copy of this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> initialized to the input <a href="#id31"><span class="problematic" id="id32">:param:`audio_data`</span></a> numpy array.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.make_copy_with_stft_data" title="nussl.core.AudioSignal.make_copy_with_stft_data"><code class="xref py py-obj docutils literal notranslate"><span class="pre">make_copy_with_stft_data</span></code></a>(stft_data[, verbose])</p></td>
<td><p>Makes a copy of this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with <code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code> initialized to the input <a href="#id33"><span class="problematic" id="id34">:param:`stft_data`</span></a> numpy array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.peak_normalize" title="nussl.core.AudioSignal.peak_normalize"><code class="xref py py-obj docutils literal notranslate"><span class="pre">peak_normalize</span></code></a>()</p></td>
<td><p>Peak normalizes the audio signal.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.play" title="nussl.core.AudioSignal.play"><code class="xref py py-obj docutils literal notranslate"><span class="pre">play</span></code></a>()</p></td>
<td><p>Plays this audio signal, using <cite>nussl.play_utils.play</cite>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.resample" title="nussl.core.AudioSignal.resample"><code class="xref py py-obj docutils literal notranslate"><span class="pre">resample</span></code></a>(new_sample_rate, **kwargs)</p></td>
<td><p>Resample the data in <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> to the new sample rate provided by <a href="#id35"><span class="problematic" id="id36">:param:`new_sample_rate`</span></a>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.rms" title="nussl.core.AudioSignal.rms"><code class="xref py py-obj docutils literal notranslate"><span class="pre">rms</span></code></a>([win_len, hop_len])</p></td>
<td><p>Calculates the root-mean-square of <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.set_active_region" title="nussl.core.AudioSignal.set_active_region"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_active_region</span></code></a>(start, end)</p></td>
<td><p>Determines the bounds of what gets returned when you access <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.set_active_region_to_default" title="nussl.core.AudioSignal.set_active_region_to_default"><code class="xref py py-obj docutils literal notranslate"><span class="pre">set_active_region_to_default</span></code></a>()</p></td>
<td><p>Resets the active region of this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object to its default value of the entire <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> array.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-obj docutils literal notranslate"><span class="pre">stft</span></code></a>([window_length, hop_length, …])</p></td>
<td><p>Computes the Short Time Fourier Transform (STFT) of <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code>.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.subtract" title="nussl.core.AudioSignal.subtract"><code class="xref py py-obj docutils literal notranslate"><span class="pre">subtract</span></code></a>(other)</p></td>
<td><p>Subtracts two audio signal objects.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.to_mono" title="nussl.core.AudioSignal.to_mono"><code class="xref py py-obj docutils literal notranslate"><span class="pre">to_mono</span></code></a>([overwrite, keep_dims])</p></td>
<td><p>Converts <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> to mono by averaging every sample.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.truncate_samples" title="nussl.core.AudioSignal.truncate_samples"><code class="xref py py-obj docutils literal notranslate"><span class="pre">truncate_samples</span></code></a>(n_samples)</p></td>
<td><p>Truncates the signal leaving only the first <code class="docutils literal notranslate"><span class="pre">n_samples</span></code> samples.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.truncate_seconds" title="nussl.core.AudioSignal.truncate_seconds"><code class="xref py py-obj docutils literal notranslate"><span class="pre">truncate_seconds</span></code></a>(n_seconds)</p></td>
<td><p>Truncates the signal leaving only the first n_seconds.</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.write_audio_to_file" title="nussl.core.AudioSignal.write_audio_to_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">write_audio_to_file</span></code></a>(output_file_path[, …])</p></td>
<td><p>Outputs the audio signal data in <code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code> to a file at <a href="#id37"><span class="problematic" id="id38">:param:`output_file_path`</span></a> with sample rate of <a href="#id39"><span class="problematic" id="id40">:param:`sample_rate`</span></a>.</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#nussl.core.AudioSignal.zero_pad" title="nussl.core.AudioSignal.zero_pad"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zero_pad</span></code></a>(before, after)</p></td>
<td><p>Adds zeros before and after the signal to all channels.</p></td>
</tr>
</tbody>
</table>
<p>and more. The <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> class is used in all source separation objects in <em>nussl</em>.</p>
<p><a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object stores time-series audio data as a 2D <code class="docutils literal notranslate"><span class="pre">numpy</span></code> array in
<a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> (see <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> for details) and stores Short-Time Fourier Transform
data as 3D <code class="docutils literal notranslate"><span class="pre">numpy</span></code> array in <span class="xref std std-ref">stft_data</span> (see <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> for details).</p>
<p><strong>Initialization</strong></p>
<p>There are a few options for initializing an <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object. The first is to
initialize an empty <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object, with no parameters:</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">nussl</span>
<span class="gp">>>> </span><span class="n">signal</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">()</span>
</pre></div>
</div>
<p>In this case, there is no data stored in <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> or in <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>, though
these attributes can be updated at any time after the object has been created.</p>
<p>Additionally, an <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object can be loaded with exactly one of the following:</p>
<blockquote>
<div><ol class="arabic simple">
<li><p>A path to an input audio file (see <a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_file" title="nussl.core.AudioSignal.load_audio_from_file"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_audio_from_file()</span></code></a> for details).</p></li>
<li><p>A <cite>numpy</cite> array of 1D or 2D real-valued time-series audio data.</p></li>
<li><p>A <cite>numpy</cite> array of 2D or 3D complex-valued time-frequency STFT data.</p></li>
</ol>
</div></blockquote>
<p><a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> will throw an error if it is initialized with more than one of the
previous at once.</p>
<p>Here are examples of all three of these cases:</p>
<blockquote>
<div><div class="highlight-python notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre> 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</pre></div></td><td class="code"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
<span class="kn">import</span> <span class="nn">nussl</span>
<span class="c1"># Initializing an empty AudioSignal object:</span>
<span class="n">sig_empty</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">()</span>
<span class="c1"># Initializing from a path:</span>
<span class="n">file_path</span> <span class="o">=</span> <span class="s1">'my/awesome/mixture.wav'</span>
<span class="n">sig_path</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span>
<span class="c1"># Initializing with a 1D or 2D numpy array containing audio data:</span>
<span class="n">aud_1d</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="n">np</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="mf">0.0</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">,</span> <span class="mi">48000</span><span class="p">))</span>
<span class="n">sig_1d</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">audio_data_array</span><span class="o">=</span><span class="n">aud_1d</span><span class="p">,</span> <span class="n">sample_rate</span><span class="o">=</span><span class="mi">48000</span><span class="p">)</span>
<span class="c1"># FYI: The shape doesn't matter, nussl will correct for it</span>
<span class="n">aud_2d</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">array</span><span class="p">([</span><span class="n">aud_1d</span><span class="p">,</span> <span class="o">-</span><span class="mi">2</span> <span class="o">*</span> <span class="n">aud_1d</span><span class="p">])</span>
<span class="n">sig_2d</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">audio_data_array</span><span class="o">=</span><span class="n">aud_2d</span><span class="p">)</span>
<span class="c1"># Initializing with a 2D or 3D numpy array containing STFT data:</span>
<span class="n">stft_2d</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">((</span><span class="mi">513</span><span class="p">,</span> <span class="mi">300</span><span class="p">))</span> <span class="o">+</span> <span class="mi">1</span><span class="n">j</span> <span class="o">*</span> <span class="n">np</span><span class="o">.</span><span class="n">random</span><span class="o">.</span><span class="n">rand</span><span class="p">((</span><span class="mi">513</span><span class="p">,</span> <span class="mi">300</span><span class="p">))</span>
<span class="n">sig_stft_2d</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">stft</span><span class="o">=</span><span class="n">stft_2d</span><span class="p">)</span>
<span class="c1"># Two channels of STFT data:</span>
<span class="n">stft_3d</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">complex_randn</span><span class="p">((</span><span class="mi">513</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span>
<span class="n">sig_stft_3d</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">stft</span><span class="o">=</span><span class="n">stft_3d</span><span class="p">)</span>
<span class="c1"># Initializing with more than one of the above methods will raise an exception:</span>
<span class="n">sig_exception</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">audio_data_array</span><span class="o">=</span><span class="n">aud_2d</span><span class="p">,</span> <span class="n">stft</span><span class="o">=</span><span class="n">stft_2d</span><span class="p">)</span>
</pre></div>
</td></tr></table></div>
</div></blockquote>
<p>When initializing from a path, <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> can read many types of audio files,
provided that your computer has the backends installed to understand the corresponding codecs.
<em>nussl</em> uses <code class="docutils literal notranslate"><span class="pre">librosa</span></code>’s <cite>load</cite> function to read in audio data. See librosa’s documentation
for details: <a class="reference external" href="https://github.com/librosa/librosa#audioread">https://github.com/librosa/librosa#audioread</a></p>
<p>Once initialized with a single type of data (time-series or time-frequency), there are methods
to compute an STFT from time-series data (<a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a>) and vice versa (<a class="reference internal" href="#nussl.core.AudioSignal.istft" title="nussl.core.AudioSignal.istft"><code class="xref py py-func docutils literal notranslate"><span class="pre">istft()</span></code></a>).</p>
<p><strong>Sample Rate</strong></p>
<p>The sample rate of an <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object is set upon initialization. If initializing
from a path, the sample rate of the <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object inherits the native sample
rate from the file. If initialized with an audio or stft data array, the sample rate is passed
in as an optional argument. In these cases, with no sample rate explicitly defined, the default
sample rate is 44.1 kHz (CD quality). If this argument is provided when reading from a file
and the provided sample rate does not match the native sample rate of the file,
<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> will resample the data from the file so that it matches the provided
sample rate.</p>
<p class="rubric">Notes</p>
<p>There is no guarantee that data in <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> corresponds to data in
<a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>. E.g., when an <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object is initialized with
<a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> of an audio mixture, its <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> is <code class="docutils literal notranslate"><span class="pre">None</span></code> until <a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a>
is called. Once <a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a> is called and a mask is applied to <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> (via some
algorithm), the <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> in this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object still contains data
from the original mixture that it was initialized with even though <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>
contains altered data. (To hear the results, simply call <a class="reference internal" href="#nussl.core.AudioSignal.istft" title="nussl.core.AudioSignal.istft"><code class="xref py py-func docutils literal notranslate"><span class="pre">istft()</span></code></a> on the
<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object.) It is up to the user to keep track of the contents of
<a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> and <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p>For a walk-through of AudioSignal features, see <span class="xref std std-ref">audio_signal_basics</span> and
<span class="xref std std-ref">audio_signal_stft</span>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>path_to_input_file</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – Path to an input file to load upon initialization. Audio
gets loaded into <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p></li>
<li><p><strong>audio_data_array</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>) – 1D or 2D numpy array containing a real-valued,
time-series representation of the audio.</p></li>
<li><p><strong>stft</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>) – 2D or 3D numpy array containing pre-computed complex-valued STFT
data.</p></li>
<li><p><strong>label</strong> (<code class="docutils literal notranslate"><span class="pre">str</span></code>) – A label for this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object.</p></li>
<li><p><strong>offset</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Starting point of the section to be extracted (in seconds) if
initializing from a file.</p></li>
<li><p><strong>duration</strong> (<code class="docutils literal notranslate"><span class="pre">float</span></code>) – Length of the signal to read from the file (in seconds). Defaults to
full length of the signal (i.e., <code class="docutils literal notranslate"><span class="pre">None</span></code>).</p></li>
<li><p><strong>sample_rate</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – Sampling rate of this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object.</p></li>
</ul>
</dd>
</dl>
<dl class="attribute">
<dt id="nussl.core.AudioSignal.path_to_input_file">
<code class="sig-name descname">path_to_input_file</code><a class="headerlink" href="#nussl.core.AudioSignal.path_to_input_file" title="Permalink to this definition">¶</a></dt>
<dd><p>Path to the input file. <code class="docutils literal notranslate"><span class="pre">None</span></code> if this AudioSignal never
loaded a file, i.e., initialized with a <code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="attribute">
<dt id="nussl.core.AudioSignal.label">
<code class="sig-name descname">label</code><a class="headerlink" href="#nussl.core.AudioSignal.label" title="Permalink to this definition">¶</a></dt>
<dd><p>A user-definable label for this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object.</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.active_region_is_default">
<em class="property">property </em><code class="sig-name descname">active_region_is_default</code><a class="headerlink" href="#nussl.core.AudioSignal.active_region_is_default" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">bool</span></code></dt><dd><p><code class="docutils literal notranslate"><span class="pre">True</span></code> if active region is the full length of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>. <code class="docutils literal notranslate"><span class="pre">False</span></code> otherwise.</p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.set_active_region" title="nussl.core.AudioSignal.set_active_region"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_active_region()</span></code></a> for a description of active regions in <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a></p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.set_active_region_to_default" title="nussl.core.AudioSignal.set_active_region_to_default"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_active_region_to_default()</span></code></a></p></li>
</ul>
</div>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.add">
<code class="sig-name descname">add</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.add"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.add" title="Permalink to this definition">¶</a></dt>
<dd><p>Adds two audio signal objects.</p>
<p>This does element-wise addition on the <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> array.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If <code class="docutils literal notranslate"><span class="pre">self.sample_rate</span> <span class="pre">!=</span> <span class="pre">other.sample_rate</span></code>,
<code class="docutils literal notranslate"><span class="pre">self.num_channels</span> <span class="pre">!=</span> <span class="pre">other.num_channels</span></code>, or
<code class="docutils literal notranslate"><span class="pre">self.active_region_is_default</span></code> is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><p><strong>other</strong> (<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>) – Other <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> to add.</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>New <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with the sum of
<code class="docutils literal notranslate"><span class="pre">self</span></code> and <code class="docutils literal notranslate"><span class="pre">other</span></code>.</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>(<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.apply_gain">
<code class="sig-name descname">apply_gain</code><span class="sig-paren">(</span><em class="sig-param">value</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.apply_gain"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.apply_gain" title="Permalink to this definition">¶</a></dt>
<dd><p>Apply a gain to <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a></p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>value</strong> (<em>float</em>) – amount to multiply self.audio_data by</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>This <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with the gain applied.</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>(<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.apply_mask">
<code class="sig-name descname">apply_mask</code><span class="sig-paren">(</span><em class="sig-param">mask</em>, <em class="sig-param">overwrite=False</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.apply_mask"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.apply_mask" title="Permalink to this definition">¶</a></dt>
<dd><p>Applies the input mask to the time-frequency representation in this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>
object and returns a new <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object with the mask applied. The mask
is applied to the magnitude of audio signal. The phase of the original audio
signal is then applied to construct the masked STFT.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>mask</strong> (<code class="xref py py-obj docutils literal notranslate"><span class="pre">MaskBase</span></code>-derived object) – A <code class="docutils literal notranslate"><span class="pre">MaskBase</span></code>-derived object
containing a mask.</p></li>
<li><p><strong>overwrite</strong> (<em>bool</em>) – If <code class="docutils literal notranslate"><span class="pre">True</span></code>, this will alter <code class="docutils literal notranslate"><span class="pre">stft_data</span></code> in self.
If <code class="docutils literal notranslate"><span class="pre">False</span></code>, this function will create a new <code class="docutils literal notranslate"><span class="pre">AudioSignal</span></code> object
with the mask applied.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>A new <code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal`</span></code> object with the input mask applied to the STFT,
iff <code class="docutils literal notranslate"><span class="pre">overwrite</span></code> is False.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.audio_data">
<em class="property">property </em><code class="sig-name descname">audio_data</code><a class="headerlink" href="#nussl.core.AudioSignal.audio_data" title="Permalink to this definition">¶</a></dt>
<dd><dl>
<dt><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></dt><dd><p>Stored as a <code class="docutils literal notranslate"><span class="pre">numpy</span></code> <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>, <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> houses the raw, uncompressed
time-domain audio data in the <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>. Audio data is stored with shape
<code class="docutils literal notranslate"><span class="pre">(n_channels,</span> <span class="pre">n_samples)</span></code> as an array of floats.</p>
<p><code class="docutils literal notranslate"><span class="pre">None</span></code> by default, can be initialized upon object instantiation or set at any time by
accessing this attribute or calling <a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_array" title="nussl.core.AudioSignal.load_audio_from_array"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_audio_from_array()</span></code></a>. It is recommended to
set <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> by using <a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_array" title="nussl.core.AudioSignal.load_audio_from_array"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_audio_from_array()</span></code></a> if this
<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> has been initialized without any audio or STFT data.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If set incorrectly, will raise an error. Expects a real, finite-valued 1D or 2D
<code class="docutils literal notranslate"><span class="pre">numpy</span></code> <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>-typed array.</p>
</dd>
</dl>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p><a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> and <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> are not automatically synchronized, meaning
that if one of them is changed, those changes are not instantly reflected in the other.
To propagate changes, either call <a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a> or <a class="reference internal" href="#nussl.core.AudioSignal.istft" title="nussl.core.AudioSignal.istft"><code class="xref py py-func docutils literal notranslate"><span class="pre">istft()</span></code></a>.</p>
</div>
<p class="rubric">Notes</p>
<ul class="simple">
<li><dl class="simple">
<dt>This attribute only returns values within the active region. For more information</dt><dd><p>see <a class="reference internal" href="#nussl.core.AudioSignal.set_active_region_to_default" title="nussl.core.AudioSignal.set_active_region_to_default"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_active_region_to_default()</span></code></a>. When setting this attribute, the active
region are reset to default.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>If <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> is set with an improperly transposed array, it will</dt><dd><p>automatically transpose it so that it is set the expected way. A warning will be
displayed on the console.</p>
</dd>
</dl>
</li>
</ul>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><dl class="simple">
<dt><a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_file" title="nussl.core.AudioSignal.load_audio_from_file"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_audio_from_file()</span></code></a> to load audio into <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> after</dt><dd><p>initialization.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt><a class="reference internal" href="#nussl.core.AudioSignal.load_audio_from_array" title="nussl.core.AudioSignal.load_audio_from_array"><code class="xref py py-func docutils literal notranslate"><span class="pre">load_audio_from_array()</span></code></a> to safely load audio into <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> after</dt><dd><p>initialization.</p>
</dd>
</dl>
</li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.set_active_region_to_default" title="nussl.core.AudioSignal.set_active_region_to_default"><code class="xref py py-func docutils literal notranslate"><span class="pre">set_active_region_to_default()</span></code></a> for more information about the active region.</p></li>
<li><dl class="simple">
<dt><a class="reference internal" href="#nussl.core.AudioSignal.signal_duration" title="nussl.core.AudioSignal.signal_duration"><code class="xref py py-attr docutils literal notranslate"><span class="pre">signal_duration</span></code></a> and <a class="reference internal" href="#nussl.core.AudioSignal.signal_length" title="nussl.core.AudioSignal.signal_length"><code class="xref py py-attr docutils literal notranslate"><span class="pre">signal_length</span></code></a> for length of audio data in seconds</dt><dd><p>and samples, respectively.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt><a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a> to calculate an STFT from this data,</dt><dd><p>and <a class="reference internal" href="#nussl.core.AudioSignal.istft" title="nussl.core.AudioSignal.istft"><code class="xref py py-func docutils literal notranslate"><span class="pre">istft()</span></code></a> to calculate the inverse STFT and put it in <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p>
</dd>
</dl>
</li>
<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">plot_time_domain()</span></code> to create a plot of audio data stored in this attribute.</p></li>
<li><dl class="simple">
<dt><a class="reference internal" href="#nussl.core.AudioSignal.peak_normalize" title="nussl.core.AudioSignal.peak_normalize"><code class="xref py py-func docutils literal notranslate"><span class="pre">peak_normalize()</span></code></a> to apply gain such that to the absolute max value is exactly</dt><dd><p><code class="docutils literal notranslate"><span class="pre">1.0</span></code>.</p>
</dd>
</dl>
</li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.rms" title="nussl.core.AudioSignal.rms"><code class="xref py py-func docutils literal notranslate"><span class="pre">rms()</span></code></a> to calculate the root-mean-square of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a></p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.apply_gain" title="nussl.core.AudioSignal.apply_gain"><code class="xref py py-func docutils literal notranslate"><span class="pre">apply_gain()</span></code></a> to apply a gain.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channel" title="nussl.core.AudioSignal.get_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channel()</span></code></a> to safely retrieve a single channel in <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p></li>
</ul>
</div>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.concat">
<code class="sig-name descname">concat</code><span class="sig-paren">(</span><em class="sig-param">other</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.concat"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.concat" title="Permalink to this definition">¶</a></dt>
<dd><p>Concatenate two <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> objects (by concatenating <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>).</p>
<p>Puts <code class="docutils literal notranslate"><span class="pre">other.audio_data</span></code> after <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If <code class="docutils literal notranslate"><span class="pre">self.sample_rate</span> <span class="pre">!=</span> <span class="pre">other.sample_rate</span></code>,
<code class="docutils literal notranslate"><span class="pre">self.num_channels</span> <span class="pre">!=</span> <span class="pre">other.num_channels</span></code>, or <code class="docutils literal notranslate"><span class="pre">!self.active_region_is_default</span></code>
is <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><p><strong>other</strong> (<a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a>) – <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> to concatenate with the current one.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.crop_signal">
<code class="sig-name descname">crop_signal</code><span class="sig-paren">(</span><em class="sig-param">before</em>, <em class="sig-param">after</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.crop_signal"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.crop_signal" title="Permalink to this definition">¶</a></dt>
<dd><p>Get rid of samples before and after the signal on all channels. Contracts the length
of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> by before + after. Useful to get rid of zero padding after the fact.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>before</strong> – (int) number of samples to remove at beginning of self.audio_data</p></li>
<li><p><strong>after</strong> – (int) number of samples to remove at end of self.audio_data</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.embed_audio">
<code class="sig-name descname">embed_audio</code><span class="sig-paren">(</span><em class="sig-param">ext='.mp3'</em>, <em class="sig-param">display=True</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.embed_audio"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.embed_audio" title="Permalink to this definition">¶</a></dt>
<dd><p>Embeds the audio signal into a notebook, using <cite>nussl.play_utils.embed_audio</cite>.</p>
<p>Write a numpy array to a temporary mp3 file using ffmpy, then embeds the mp3
into the notebook.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ext</strong> (<em>str</em>) – What extension to use when embedding. ‘.mp3’ is more lightweight</p></li>
<li><p><strong>to smaller notebook sizes.</strong> (<em>leading</em>) – </p></li>
</ul>
</dd>
</dl>
<p class="rubric">Example</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">import</span> <span class="nn">nussl</span>
<span class="gp">>>> </span><span class="n">audio_file</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">efz_utils</span><span class="o">.</span><span class="n">download_audio_file</span><span class="p">(</span><span class="s1">'schoolboy_fascination_excerpt.wav'</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">audio_signal</span> <span class="o">=</span> <span class="n">nussl</span><span class="o">.</span><span class="n">AudioSignal</span><span class="p">(</span><span class="n">audio_file</span><span class="p">)</span>
<span class="gp">>>> </span><span class="n">audio_signal</span><span class="o">.</span><span class="n">embed_audio</span><span class="p">()</span>
</pre></div>
</div>
<p>This will show a little audio player where you can play the audio inline in
the notebook.</p>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.file_name">
<em class="property">property </em><code class="sig-name descname">file_name</code><a class="headerlink" href="#nussl.core.AudioSignal.file_name" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">str</span></code></dt><dd><p>The name of the file associated with this object. Includes extension, but not the full
path.</p>
</dd>
</dl>
<p class="rubric">Notes</p>
<p>This will return <code class="docutils literal notranslate"><span class="pre">None</span></code> if this <a class="reference internal" href="#nussl.core.AudioSignal" title="nussl.core.AudioSignal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AudioSignal</span></code></a> object was not
loaded from a file.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="#nussl.core.AudioSignal.path_to_input_file" title="nussl.core.AudioSignal.path_to_input_file"><code class="xref py py-attr docutils literal notranslate"><span class="pre">path_to_input_file</span></code></a> for the full path.</p>
</div>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.freq_vector">
<em class="property">property </em><code class="sig-name descname">freq_vector</code><a class="headerlink" href="#nussl.core.AudioSignal.freq_vector" title="Permalink to this definition">¶</a></dt>
<dd><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code></dt><dd><p>A 1D numpy array with frequency values (in Hz) that correspond
to each frequency bin (vertical axis) in <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>. Assumes
linearly spaced frequency bins.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> is <code class="docutils literal notranslate"><span class="pre">None</span></code>.
Run <a class="reference internal" href="#nussl.core.AudioSignal.stft" title="nussl.core.AudioSignal.stft"><code class="xref py py-func docutils literal notranslate"><span class="pre">stft()</span></code></a> before accessing this.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_channel">
<code class="sig-name descname">get_channel</code><span class="sig-paren">(</span><em class="sig-param">n</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Gets audio data of n-th channel from <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> as a 1D <code class="xref py py-obj docutils literal notranslate"><span class="pre">np.ndarray</span></code>
of shape <code class="docutils literal notranslate"><span class="pre">(n_samples,)</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>n</strong> (<em>int</em>) – index of channel to get. <strong>0-based</strong></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channels" title="nussl.core.AudioSignal.get_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channels()</span></code></a>: Generator for looping through channels of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channel" title="nussl.core.AudioSignal.get_stft_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channel()</span></code></a>: Gets stft data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channels" title="nussl.core.AudioSignal.get_stft_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channels()</span></code></a>: Generator for looping through channels from</p></li>
</ul>
<p><a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>.</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If not <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">n</span> <span class="pre"><</span> <span class="pre">self.num_channels</span></code>.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>The audio data in the n-th channel of the signal, 1D</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_channels">
<code class="sig-name descname">get_channels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_channels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_channels" title="Permalink to this definition">¶</a></dt>
<dd><p>Generator that will loop through channels of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channel" title="nussl.core.AudioSignal.get_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channel()</span></code></a>: Gets audio data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channel" title="nussl.core.AudioSignal.get_stft_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channel()</span></code></a>: Gets stft data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channels" title="nussl.core.AudioSignal.get_stft_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channels()</span></code></a>: Generator to loop through channels of <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>.</p></li>
</ul>
</div>
<dl class="field-list simple">
<dt class="field-odd">Yields</dt>
<dd class="field-odd"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>) – The audio data in the next channel of this signal as a
1D <code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_magnitude_spectrogram_channel">
<code class="sig-name descname">get_magnitude_spectrogram_channel</code><span class="sig-paren">(</span><em class="sig-param">n</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_magnitude_spectrogram_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_magnitude_spectrogram_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the n-th channel from <code class="docutils literal notranslate"><span class="pre">self.magnitude_spectrogram_data</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>Exception</strong> – If not <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">n</span> <span class="pre"><</span> <span class="pre">self.num_channels</span></code>.</p>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><p><strong>n</strong> – (int) index of magnitude spectrogram channel to get <strong>0-based</strong></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the magnitude spectrogram data in the n-th channel of the signal, 1D</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_power_spectrogram_channel">
<code class="sig-name descname">get_power_spectrogram_channel</code><span class="sig-paren">(</span><em class="sig-param">n</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_power_spectrogram_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_power_spectrogram_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns the n-th channel from <code class="docutils literal notranslate"><span class="pre">self.power_spectrogram_data</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>Exception</strong> – If not <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">n</span> <span class="pre"><</span> <span class="pre">self.num_channels</span></code>.</p>
</dd>
<dt class="field-even">Parameters</dt>
<dd class="field-even"><p><strong>n</strong> – (int) index of power spectrogram channel to get <strong>0-based</strong></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>the power spectrogram data in the n-th channel of the signal, 1D</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_stft_channel">
<code class="sig-name descname">get_stft_channel</code><span class="sig-paren">(</span><em class="sig-param">n</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_stft_channel"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_stft_channel" title="Permalink to this definition">¶</a></dt>
<dd><p>Returns STFT data of n-th channel from <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> as a 2D <code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>n</strong> – (int) index of stft channel to get. <strong>0-based</strong></p>
</dd>
</dl>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channels" title="nussl.core.AudioSignal.get_stft_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channels()</span></code></a>: Generator to loop through channels from <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channel" title="nussl.core.AudioSignal.get_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channel()</span></code></a>: Gets audio data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channels" title="nussl.core.AudioSignal.get_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channels()</span></code></a>: Generator to loop through channels of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p></li>
</ul>
</div>
<dl class="field-list simple">
<dt class="field-odd">Raises</dt>
<dd class="field-odd"><p><strong>AudioSignalException</strong> – If not <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">n</span> <span class="pre"><</span> <span class="pre">self.num_channels</span></code>.</p>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>the STFT data in the n-th channel of the signal, 2D</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>)</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_stft_channels">
<code class="sig-name descname">get_stft_channels</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_stft_channels"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_stft_channels" title="Permalink to this definition">¶</a></dt>
<dd><p>Generator that will loop through channels of <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a>.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<ul class="simple">
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_stft_channel" title="nussl.core.AudioSignal.get_stft_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_stft_channel()</span></code></a>: Gets stft data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channel" title="nussl.core.AudioSignal.get_channel"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channel()</span></code></a>: Gets audio data from a specific channel.</p></li>
<li><p><a class="reference internal" href="#nussl.core.AudioSignal.get_channels" title="nussl.core.AudioSignal.get_channels"><code class="xref py py-func docutils literal notranslate"><span class="pre">get_channels()</span></code></a>: Generator to loop through channels of <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a>.</p></li>
</ul>
</div>
<dl class="field-list simple">
<dt class="field-odd">Yields</dt>
<dd class="field-odd"><p>(<code class="xref py py-obj docutils literal notranslate"><span class="pre">np.array</span></code>) – The STFT data in the next channel of this signal as a
2D <code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>.</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.get_window">
<em class="property">static </em><code class="sig-name descname">get_window</code><span class="sig-paren">(</span><em class="sig-param">window_type</em>, <em class="sig-param">window_length</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.get_window"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.get_window" title="Permalink to this definition">¶</a></dt>
<dd><p>Wrapper around scipy.signal.get_window so one can also get the
popular sqrt-hann window.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>window_type</strong> (<em>str</em>) – Type of window to get (see constants.ALL_WINDOW).</p></li>
<li><p><strong>window_length</strong> (<em>int</em>) – Length of the window</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Window returned by scipy.signa.get_window</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>np.ndarray</p>
</dd>
</dl>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.has_data">
<em class="property">property </em><code class="sig-name descname">has_data</code><a class="headerlink" href="#nussl.core.AudioSignal.has_data" title="Permalink to this definition">¶</a></dt>
<dd><p><code class="docutils literal notranslate"><span class="pre">bool</span></code>
Returns <code class="docutils literal notranslate"><span class="pre">False</span></code> if <a class="reference internal" href="#nussl.core.AudioSignal.audio_data" title="nussl.core.AudioSignal.audio_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">audio_data</span></code></a> and <a class="reference internal" href="#nussl.core.AudioSignal.stft_data" title="nussl.core.AudioSignal.stft_data"><code class="xref py py-attr docutils literal notranslate"><span class="pre">stft_data</span></code></a> are empty. Else,
returns <code class="docutils literal notranslate"><span class="pre">True</span></code>.</p>
</dd></dl>
<dl class="method">
<dt id="nussl.core.AudioSignal.ipd_ild_features">
<code class="sig-name descname">ipd_ild_features</code><span class="sig-paren">(</span><em class="sig-param">ch_one=0</em>, <em class="sig-param">ch_two=1</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/nussl/core/audio_signal.html#AudioSignal.ipd_ild_features"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#nussl.core.AudioSignal.ipd_ild_features" title="Permalink to this definition">¶</a></dt>
<dd><p>Computes interphase difference (IPD) and interlevel difference (ILD) for a
stereo spectrogram. If more than two channels, this by default computes IPD/ILD
between the first two channels. This can be specified by the arguments ch_one
and ch_two. If only one channel, this raises an error.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ch_one</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – index of first channel to compute IPD/ILD.</p></li>
<li><p><strong>ch_two</strong> (<code class="docutils literal notranslate"><span class="pre">int</span></code>) – index of second channel to compute IPD/ILD.</p></li>
</ul>
</dd>
<dt class="field-even">Returns</dt>
<dd class="field-even"><p>Interphase difference between selected channels
ild (<code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>): Interlevel difference between selected channels</p>
</dd>
<dt class="field-odd">Return type</dt>
<dd class="field-odd"><p>ipd (<code class="docutils literal notranslate"><span class="pre">np.ndarray</span></code>)</p>
</dd>