average~
Multi-mode signal average
Description
Use the average~ to perform bipolar , absolute , or rms averaging on any input signal.
Arguments
max-averaging-interval[int]samples
optional
Sets the maximum averaging interval in samples. The default value is 100.
averaging-mode[symbol]
optional
Sets the averaging mode, as defined in the "Messages" section. The default is bipolar .
Attributes
mode[symbol]
8.0.0
Sets the averaging mode for the input signal.
Possible values:
'bipolar'
(
Average input
)
Sets bipolar averaging mode (default). In bipolar mode, the sample values are averaged.
'absolute'
(
Average the absolute value of input
)
Sets absolute averaging mode. This mode averages the absolute value of the incoming samples.
'rms'
(
Root mean square input
)
Sets root mean square (RMS) averaging mode. This mode computes the square root of the average of the sample values squared.
The RMS mode of the average~ object is more CPU-intensive than the bipolar and absolute modes. While RMS values are often used to measure signal levels, the absolute mode often works as well as the RMS mode in many level-detection tasks.
Common Box Attributes
annotation[symbol]
Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.
background[int]: 0
Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.
color[4 floats]
Sets the color for the object box outline.
fontface[int]
Sets the type style used by the object. The options are:
plain
bold
italic
bold italic
Possible values:
0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'
fontname[symbol]
Sets the object's font.
fontsize[float]
Sets the object's font size (in points).
Possible values:
'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'
hint[symbol]
Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.
ignoreclick[int]: 0
Toggles whether an object ignores mouse clicks in a locked patcher.
jspainterfile[symbol]
You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.
patching_rect[4 floats]: 0. 0. 100. 0.
Sets the position and size of the object in the patcher window.
position[2 floats]
write-only
Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.
presentation[int]: 0
Sets whether an object belongs to the patcher's presentation.
presentation_rect[4 floats]: 0. 0. 0. 0.
Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.
rect[4 floats]
write-only
Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).
size[2 floats]
write-only
Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.
textcolor[4 floats]
Sets the color for the object's text in RGBA format.
textjustification[int]
Sets the justification for the object's text.
Possible values:
0 = 'left'
1 = 'center'
2 = 'right'
varname[symbol]
Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.
Messages
int
Sets the interval in samples used for each of the three modes of signal averaging. The default value is 100 .
- averaging-sample-interval
[int]
absolute
Sets absolute averaging mode. This mode averages the absolute value of the incoming samples.
bipolar
Sets bipolar averaging mode (default). In bipolar mode, the sample values are averaged.
rms
Sets root mean square (RMS) averaging mode. This mode computes the square root of the average of the sample values squared.
The RMS mode of the average~ object is more CPU-intensive than the bipolar and absolute modes.While RMS values are often used to measure signal levels, the absolute mode often works as well as the RMS mode in many level-detection tasks.
signal
The signal to be averaged.
Output
signal
The running average value of the input signal averaged over the specified number of samples.
See Also
| Name | Description |
|---|---|
| avg~ | Signal average |
| meter~ | Visual peak level indicator |