xal.tools.dsp

Class DigitalIntegrator

java.lang.Object

xal.tools.dsp.AbstractDigitalFilter

xal.tools.dsp.LtiDigitalFilter

xal.tools.dsp.DigitalIntegrator

public class DigitalIntegrator
extends LtiDigitalFilter

Convenience class implementing a simple 1^st order digital integrator. The response y_n of this filter to an input x_n is given by

y_n = y_n-1 + x_n

Thus, the transfer function H(z) is given by

H(z) = 1/(1 - z^-1)

where z is the Z-transform variable. Note that the integrator is unstable for zero frequency corresponding to z = 1, which is expected for integration.

The integrator is initialized so that the constant of integration (y_-1) is zero. This value may be changed with a call to setConstantOfIntegration(double).

See Also:

gov.sns.tools.dsp.LtiDigitalFilter

Constructor Summary

Constructors

Constructor and Description
DigitalIntegrator() Create a new DigitalIntegrator object with zero constant of integration.
DigitalIntegrator(double dblConst) Create a new DigitalIntegrator object with the given constant of integration.

Method Summary

Modifier and Type	Method and Description
void	setConstantOfIntegration(double dblConst) Sets the constant of integration equal to the given value.

Methods inherited from class xal.tools.dsp.LtiDigitalFilter

getInputCoefficient, getInputCoefficient, getOutputCoefficient, getOutputCoefficient, setInputCoefficient, setInputCoefficients, setOutputCoefficient, setOutputCoefficients, toString, transferFunction

Methods inherited from class xal.tools.dsp.AbstractDigitalFilter

getCoefficientCount, getOrder, getTimeIndex, reset, response, response

Methods inherited from class java.lang.Object

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

Constructor Detail

DigitalIntegrator

public DigitalIntegrator()

Create a new DigitalIntegrator object with zero constant of integration.

DigitalIntegrator

public DigitalIntegrator(double dblConst)

Create a new DigitalIntegrator object with the given constant of integration.

Parameters:

dblConst - constant of integration

See Also:

setConstantOfIntegration(double)

Method Detail

setConstantOfIntegration

public void setConstantOfIntegration(double dblConst)

Sets the constant of integration equal to the given value. Note also that the filter is reset.

Parameters:

dblConst - constant of integration

See Also:

AbstractDigitalFilter.reset()