HelpSource/Classes/Peak.schelp

   1 class:: Peak
   2 summary:: Track peak signal amplitude.
   3 related:: Classes/PeakFollower
   4 categories::  UGens>Analysis>Amplitude
   5
   6
   7 Description::
   8
   9 Outputs the peak amplitude of the signal received at the input. When
  10 a trigger occurs at the  code::reset::  input, the maximum
  11 output value is reset to the current value.
  12
  13
  14 Internally, the absolute value of the signal is used, to prevent
  15 underreporting the peak value if there is a negative DC offset. To obtain
  16 the minimum and maximum values of the signal as is, use the
  17 link::Classes/RunningMin::  and  link::Classes/RunningMax::  UGens.
  18
  19
  20 classmethods::
  21
  22 method::ar, kr
  23
  24 argument::trig
  25
  26 The input signal.
  27
  28
  29 argument::reset
  30
  31 Trigger. Resets the output value to the current input value. A
  32 trigger happens when the signal changes from non-positive to
  33 positive.
  34
  35
  36 Examples::
  37
  38 code::
  39
  40 (
  41 {
  42         SinOsc.ar(
  43                         Peak.ar(Dust.ar(20), Impulse.ar(0.4)) * 500 + 200,
  44                         0, 0.2
  45         )
  46
  47 }.play;
  48 )
  49
  50 // follow a sine lfo, reset rate controlled by mouse x
  51 (
  52 {
  53         SinOsc.ar(
  54                         Peak.kr(SinOsc.kr(0.2), Impulse.kr(MouseX.kr(0.01, 2, 1))) * 500 + 200,
  55                         0, 0.2
  56         )
  57
  58 }.play;
  59 )
  60
  61 ::
  62