Class RunningAverage

Namespace

Bonsai.Dsp

Assembly

Bonsai.Dsp.dll

Represents an operator that computes the running average of all the arrays in the sequence.

public class RunningAverage : ArrayTransform

Inheritance

object

ArrayTransform

RunningAverage

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Alpha

Gets or sets the weight to assign to each new array in the sequence. This parameter determines how fast the average forgets previous values.

[Range(0, 1)]
public double Alpha { get; set; }

Property Value

double

Methods

Process<TArray>(IObservable<TArray>)

Computes the running average of all the arrays in an observable sequence.

public override IObservable<TArray> Process<TArray>(IObservable<TArray> source) where TArray : Arr

Parameters

source IObservable<TArray>

A sequence of multi-channel array values.

Returns

IObservable<TArray>

A sequence of multi-channel arrays, where each element represents the weighted sum of the corresponding input value and the accumulated average.

Type Parameters

TArray

The type of the array-like objects in the source sequence.