xal.tools.dsp

Class DigitalAverager

java.lang.Object

xal.tools.dsp.AbstractDigitalFilter

xal.tools.dsp.DigitalAverager

public class DigitalAverager
extends AbstractDigitalFilter

Performs a running average on an input signal. This object is a linear digital filter which is not time-invariant.

Constructor Summary

Constructors

Constructor and Description
DigitalAverager() Create a new DigitalAverager object.

Method Summary

Modifier and Type	Method and Description
double	getInputCoefficient(int iTime, int iDelay) Returns the input coefficient for the given time index.
double	getOutputCoefficient(int iTime, int iDelay) Returns the output coefficient for the given time index.

Methods inherited from class xal.tools.dsp.AbstractDigitalFilter

getCoefficientCount, getOrder, getTimeIndex, reset, response, response, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DigitalAverager

public DigitalAverager()

Create a new DigitalAverager object.

Method Detail

getInputCoefficient

public double getInputCoefficient(int iTime,
                                  int iDelay)

Returns the input coefficient for the given time index. The only non-zero input coefficient is a₀ for no delay. Its value is given by

a₀(n) = 1/(n + 1)

Specified by:

getInputCoefficient in class AbstractDigitalFilter

Parameters:

iTime - current time index

iDelay - delay index of coefficient

Returns:

input coefficient for given delay index and current time

See Also:

gov.sns.tools.dsp.AbstractDigitalFilter#getInputCoefficient(int, int)

getOutputCoefficient

public double getOutputCoefficient(int iTime,
                                   int iDelay)

Returns the output coefficient for the given time index. The values of the coefficients b₀ and b₁ are given by

b₀(n) = 1

b_-1(n) = n/(n + 1)

Specified by:

getOutputCoefficient in class AbstractDigitalFilter

Parameters:

iTime - current time index

iDelay - delay index of coefficient

Returns:

output coefficient for given delay index and current time

See Also:

gov.sns.tools.dsp.AbstractDigitalFilter#getOutputCoefficient(int, int)