Merge pull request #506 from andrewcsmith/patch-2
[supercollider.git] / HelpSource / Classes / BHiPass.schelp
blob7283b6c4d454fb50214280d77ca1af434456af95
1 class:: BHiPass
2 summary:: 12db/oct rolloff - 2nd order resonant  Hi Pass Filter
3 categories:: UGens>Filters>BEQSuite
4 related:: Classes/SOS, Classes/BLowPass, Classes/BLowPass4, Classes/BHiPass4, Classes/BPeakEQ, Classes/BLowShelf, Classes/BHiShelf, Classes/BBandPass, Classes/BBandStop, Classes/BAllPass
6 description::
7 The B equalization suite is based on the Second Order Section (link::Classes/SOS::) biquad UGen.
9 note::
10 Biquad coefficient calculations imply certain amount of CPU overhead. These plugin UGens contain optimizations such that the coefficients get updated only when there has been a change to one of the filter's parameters. This can cause spikes in CPU performance and should be considered when using several of these units.
13 classmethods::
15 method:: ar
16 argument:: in
17 input signal to be processed.
18 argument:: freq
19 cutoff frequency.
20 argument:: rq
21 the reciprocal of Q.  bandwidth / cutoffFreq.
22 argument:: mul
23 argument:: add
25 method:: sc
26 calculate filter coefficients.
28 examples::
29 code::
30 s.boot;
32 z = {
33         BHiPass.ar(
34                 SoundIn.ar([0,1]),
35                 MouseX.kr(10, 20000, \exponential), // cutoff freq.
36                 MouseY.kr(0.0, 1.0, \linear), // rq
37                 0.5); // mul
38 }.play
40 z.release;