Forgot a help fix: Drag a dock's title bar, not divider, to reposition
[supercollider.git] / HelpSource / Classes / BBandStop.schelp
blob5a9ddff650a8c2c4a30364c4b6ed41bc9a092f0d
1 class:: BBandStop
2 summary:: Band reject filter
3 categories:: UGens>Filters>BEQSuite
4 related:: Classes/SOS, Classes/BLowPass, Classes/BLowPass4, Classes/BHiPass, Classes/BHiPass4, Classes/BPeakEQ, Classes/BLowShelf, Classes/BHiShelf, Classes/BBandPass, 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 center frequency.
20 argument:: bw
21 the bandwidth in octaves between -3 dB frequencies.
22 argument:: mul
23 argument:: add
25 examples::
26 code::
27 s.boot;
29 z = {
30 BBandStop.ar(
31         SoundIn.ar([0,1]),
32         MouseX.kr(20, 20000, \exponential),
33         MouseY.kr(0.0, 10.0, \linear), // bw
34         0.5); // mul
35 }.play)
36 z.release;
39 z = {
40 BBandStop.ar(
41         WhiteNoise.ar ! 2,
42         MouseX.kr(20, 20000, \exponential),
43         MouseY.kr(0.0, 10.0, \linear), // bw
44         0.1); // mul
45 }.play)
46 z.release;
49 z = { // drill...
50 BBandStop.ar(
51         SinOsc.ar(1000) ! 2,
52         MouseX.kr(800, 1200, \exponential),
53         MouseY.kr(0.0, 10.0, \linear), // bw
54         0.1); // mul
55 }.play)
56 z.release;
59 z = { // nada
60 BBandStop.ar(
61         SinOsc.ar(1000) ! 2,
62         1000,
63         MouseY.kr(0.0, 10.0, \linear), // bw
64         0.5); // mul
65 }.play)
66 z.release;