Peak: table of contents
Filter:
Classes | UGens > Analysis > Amplitude

Peak : UGen : AbstractFunction : Object

Track peak signal amplitude.
Source: Trig.sc
Subclasses: RunningMax, RunningMin

Description

Outputs the peak amplitude of the signal received at the input. When a trigger occurs at the reset input, the maximum output value is reset to the current value.

Internally, the absolute value of the signal is used, to prevent underreporting the peak value if there is a negative DC offset. To obtain the minimum and maximum values of the signal as is, use the RunningMin and RunningMax UGens.

Class Methods

Peak.ar(in: 0, trig: 0)

Peak.kr(in: 0, trig: 0)

Arguments:

in

The input signal.

trig

Trigger. Resets the output value to the current input value. A trigger happens when the signal changes from non-positive to positive.

Inherited class methods

Instance Methods

Inherited instance methods

Examples

(
{
    SinOsc.ar(
            Peak.ar(Dust.ar(20), Impulse.ar(0.4)) * 500 + 200,
            0, 0.2
    )

}.play;
)

// follow a sine lfo, reset rate controlled by mouse x
(
{
    SinOsc.ar(
            Peak.kr(SinOsc.kr(0.2), Impulse.kr(MouseX.kr(0.01, 2, 1))) * 500 + 200,
            0, 0.2
    )

}.play;
)