HelpSource/Classes/OnePole.schelp

   1 class:: OnePole
   2 summary:: One pole filter.
   3 related:: Classes/OneZero
   4 categories::  UGens>Filters>Linear
   5
   6
   7 Description::
   8
   9 A one pole filter. Implements the formula:
  10
  11 code::
  12
  13 out(i) = ((1 - abs(coef)) * in(i)) + (coef * out(i-1)).
  14
  15 ::
  16
  17
  18 classmethods::
  19
  20 method::ar, kr
  21
  22 argument::in
  23
  24 The input signal.
  25
  26
  27 argument::coef
  28
  29 Feedback coefficient. Should be between -1 and +1
  30
  31
  32 argument::mul
  33
  34 Output will be multiplied by this value.
  35
  36
  37 argument::add
  38
  39 This value will be added to the output.
  40
  41
  42 Examples::
  43
  44 code::
  45
  46 { OnePole.ar(WhiteNoise.ar(0.5), 0.95) }.play
  47
  48 { OnePole.ar(WhiteNoise.ar(0.5), -0.95) }.play
  49
  50 { OnePole.ar(WhiteNoise.ar(0.5), Line.kr(-0.99, 0.99, 10)) }.play
  51
  52 ::
  53