peakamp~ Reference

Report the maximum amplitude of a signal

peakamp~

Description

Use the peakamp~ object to monitor an incoming signal and reports the absolute value of the peak amplitude of the signal it has received since the last time it was reported.

Examples

Report the maximum of a signal's absolute value

Arguments

ms-output-interval [int]

Optional
Unitsms

Sets the internal clock interval, in milliseconds. If it is 0, the internal clock is not used, so peakamp~ will only output data when it receives a bang message. If it is non-zero, peakamp~ will repeatedly send out the peak amplitude received in that interval of time. By default, the interval is 0.

Attributes

signed [int]

When the signed attribute is set to 1, the peak amplitude of the incoming signal in the specified interval is reported, rather than the absolute value of the peak amplitude.

Common Box Attributes

Messages

bang

In left inlet: Sends out a report of the greatest (absolute value) signal amplitude received since the previous report.

signal

In left inlet: Signal to be evaluated for its peak amplitude.

Output

float

When peakamp~ receives a bang or its internal clock is on, the absolute value of the peak signal value from the input signal is sent out its outlet.

See Also

Name Description
meter~
snapshot~