File: reference-hears.txt

package info (click to toggle)
brian 1.4.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, stretch
  • size: 23,436 kB
  • sloc: python: 68,707; cpp: 29,040; ansic: 5,182; sh: 111; makefile: 61
file content (160 lines) | stat: -rw-r--r-- 3,578 bytes parent folder | download | duplicates (2)
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
.. currentmodule:: brian.hears

.. _brian-hears-reference:

Brian hears
===========

.. seealso:: User guide for :ref:`brianhears`.

.. autofunction:: set_default_samplerate

Sounds
------

.. autoclass:: Sound

.. autofunction:: savesound
.. autofunction:: loadsound
.. autofunction:: play(*sounds, normalise=False, sleep=False)
.. autofunction:: whitenoise
.. autofunction:: powerlawnoise
.. autofunction:: brownnoise
.. autofunction:: pinknoise
.. autofunction:: irns
.. autofunction:: irno
.. autofunction:: tone
.. autofunction:: click
.. autofunction:: clicks
.. autofunction:: harmoniccomplex
.. autofunction:: silence
.. autofunction:: sequence(*sounds, samplerate=None)

.. index::
	single: dB
	single: decibel
	pair: level; sound
	single: sound; dB
	single: sound; decibel

.. _dB:

dB
~~

.. autoclass:: dB_type
.. autoclass:: dB_error

Filterbanks
-----------

.. autoclass:: LinearFilterbank
.. autoclass:: FIRFilterbank
.. autoclass:: RestructureFilterbank
.. autoclass:: Join
.. autoclass:: Interleave
.. autoclass:: Repeat
.. autoclass:: Tile
.. autoclass:: FunctionFilterbank
.. autoclass:: SumFilterbank
.. autoclass:: DoNothingFilterbank
.. autoclass:: ControlFilterbank
.. autoclass:: CombinedFilterbank

Filterbank library
------------------
.. autoclass:: Gammatone(source, cf,b=1.019,erb_order=1,ear_Q=9.26449,min_bw=24.7)
.. autoclass:: ApproximateGammatone
.. autoclass:: LogGammachirp(source, f, b=1.019, c=1, ncascades=4)
.. autoclass:: LinearGammachirp
.. autoclass:: LinearGaborchirp
.. autoclass:: IIRFilterbank
.. autoclass:: Butterworth
.. autoclass:: Cascade
.. autoclass:: LowPass
.. autoclass:: AsymmetricCompensation

Auditory model library
----------------------
.. autoclass:: DRNL
.. autoclass:: DCGC
.. autoclass:: MiddleEar
.. autoclass:: TanCarney
.. autoclass:: ZhangSynapse

Filterbank group
----------------

.. autoclass:: FilterbankGroup

Functions
---------

.. autofunction:: erbspace
.. autofunction:: asymmetric_compensation_coeffs

Plotting
--------

.. autofunction:: log_frequency_xaxis_labels
.. autofunction:: log_frequency_yaxis_labels

HRTFs
-----

.. autoclass:: HRTF
.. autoclass:: HRTFSet
.. autoclass:: HRTFDatabase
.. autofunction:: make_coordinates

.. autoclass:: IRCAM_LISTEN
.. autoclass:: HeadlessDatabase

Base classes
------------

Useful for understanding more about the internals.

.. autoclass:: Bufferable

.. autoclass:: Filterbank

.. autoclass:: BaseSound

.. autoclass:: OnlineSound

.. _brian-hears-class-diagram:

Options
-------

There are several relevant global options for Brian hears. In particular,
activating scipy Weave support with the ``useweave=True`` will give considerably
faster linear filtering. See :ref:`preferences` and :ref:`compiled-code` for
more details.

Class diagram
-------------

.. inheritance-diagram:: Sound OnlineSound
						 Filterbank
						   LinearFilterbank
						     Gammatone ApproximateGammatone LogGammachirp
						     LinearGammachirp LinearGaborchirp
						   Cascade
						   IIRFilterbank
						     Butterworth
						     LowPass
						   FIRFilterbank
						   RestructureFilterbank
						     Join Interleave Repeat Tile
						   FunctionFilterbank
						     SumFilterbank
						   DoNothingFilterbank
						   ControlFilterbank
						   CombinedFilterbank
						   DRNL DCGC TanCarney
						   AsymmetricCompensation
						 HRTFDatabase
						   IRCAM_LISTEN HeadlessDatabase
	:parts: 1