Overview
Computes statistics of a block of samples
Discussion
This module calculates statistics of the input signal on a block-by-block basis. The input pin can have an arbitrary number of interleaved channels and the calculation occurs over all channels. The output pin has a single channel and a blockSize of 1.
...
An optional constructor argument OUTPUTVALUE specifies whether the computed statistic should be output on an output pin. By default, OUTPUTVALUE=0 and the statistic is only stored internally in instantaneousValue. If OUTPUTVALUE=1 then the value of the statistic is output of the first output pin as a floating-point value. If OUTPUTVALUE=2 then the module has two output pins. The first output pin is the statistic value and the second output pin is the index at which the value occurs. Using OUTPUTVALUE=2 only makes sense when statisticType=0 (max), 1 (min), or 2 (maxAbs).
Type Definition
| Code Block |
|---|
typedef struct _ModuleBlockStatistics
{
ModuleInstanceDescriptor instance; // Common Audio Weaver module instance structure
INT32 statisticsType; // Type of statistics calculated.
FLOAT32 instantaneousValue; // Instantaneous output value.
} ModuleBlockStatisticsClass; |
Variables
Properties
Name | Type | Usage | isHidden | Default value | Range | Units |
statisticsType | int | parameter | 0 | 0 | 0:9 | |
instantaneousValue | float | state | 0 | 0 | -10:10 |
Pins
Input Pins
Name: in
Description: Audio input
...
Sample rate range: Unrestricted
Complex support: Real
Output Pins
Name: out
Description: Value
...
Description: Index
Data type: int
MATLAB Usage
File Name: block_statistics_module.m
...