Engee documentation

Variance

Variance or sequence of input data.

blockType: Variance

variance

Path in the library:

/Signal Operations/Statistics/Variance

Description

Block Variance Calculates the unbiased variance of each row or column of the Input or along the vectors of a given Input dimension. It can also calculate the variance of the entire input. You can specify the measurement using the Direction Mode parameter.

Ports

Input

In — data entry
vector | the matrix

The unit accepts multi-channel and multidimensional complex or valid input data.

Data types: Float16, Float32, Float64, Int8, Int16, Int32, Int64, UInt8, UInt16, UInt32, UInt64, Bool

Output

Port_1 — variance over a given dimension
scalar | vector | the matrix

When you do not select the Running variance parameter, the block calculates the variance in each row (column) of the Input or along vectors of a given Input dimension. It can also calculate the variance of the entire Input at each individual calculation step. Each element in the output array y represents the variance of the corresponding column, row, or entire input. Output array y depends on the setting of the Direction Mode parameter.

Consider a three-dimensional input of size M to N to P. When you set the Direction Mode parameter to:

  • Entire input — the output in each calculation step is a scalar that contains the variance of the input matrix M to N to P.

  • Each row — the output in each calculation step consists of an array M to N to P where each element contains the deviation of each vector along the second dimension of the Input. For matrix Input M by N the output to each calculation step is a column vector M by 1.

  • Each column — the output in each calculation step consists of an array M to N to P where each element contains the variance of each vector over the first dimension of the Input. For M — the matrix Input N output in each calculation step is a string vector 1 by N.

    In this mode, the block processes the input undirected length vector M How M by 1 vectors are columns.

  • Specified dimension — the output in each calculation step depends on the value of the Dimension parameter. If you set Dimension to 1, the result will be the same as if you had chosen Each column. If you set Dimension to 2, the result will be the same as if you had chosen Each row. If you set Dimension to 3, the output in each calculation step will be a matrix M by N containing the variance of each vector over the third dimension of the Input.

The output data type corresponds to the input data type.

Data types: Float64

Parameters

Direction Mode — the measurement by which the pass deviation is calculated:q[<br>] Each column (by default) | Entire input | Each row | Specified dimension

  • Each column — The block displays the deviation for each column.

  • Each row — The block displays the deviation for each line.

  • Entire input — The unit displays the deviation across the entire Input.

  • Specified dimension — The block displays the deviation according to the measurement specified in the Dimension parameter

Dimension — dimension of
1 (by default) | scalar

Set the dimension (the value measured from the unit) of the input signal from which the deviation is calculated. The value of this parameter must be greater than 0 and less than or equal to the number of dimensions in the input signal.

Dependencies

To use this parameter, set the Direction Mode parameter to Specified dimension.