ptolemy.actor.lib
Class Lattice
java.lang.Object
ptolemy.kernel.util.NamedObj
ptolemy.kernel.InstantiableNamedObj
ptolemy.kernel.Entity
ptolemy.kernel.ComponentEntity
ptolemy.actor.AtomicActor
ptolemy.actor.TypedAtomicActor
ptolemy.actor.lib.Transformer
ptolemy.actor.lib.Lattice
- All Implemented Interfaces:
- ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor
- Direct Known Subclasses:
- GradientAdaptiveLattice, VariableLattice
- public class Lattice
- extends Transformer
An FIR filter with a lattice structure. The coefficients of such a
filter are called "reflection coefficients." Lattice filters are
typically used as linear predictors because it is easy to ensure that
they are minimum phase, and hence that their inverse is stable.
A lattice filter is (strictly) minimum phase if its reflection
coefficients are all less than unity in magnitude. To get the
reflection coefficients for a linear predictor for a particular
random process, you can use the LevinsonDurbin actor.
The inputs and outputs are of type double.
The default reflection coefficients correspond to the optimal linear
predictor for an AR process generated by filtering white noise with
the following filter:
1
H(z) = --------------------------------------
1 - 2z-1 + 1.91z-2 - 0.91z-3 + 0.205z-4
Since this filter is minimum phase, the transfer function of the lattice
filter is H -1 (z).
Note that the definition of reflection coefficients is not quite universal
in the literature. The reflection coefficients in reference [2]
are the negative of the ones used by this actor, which
correspond to the definition in most other texts,
and to the definition of partial-correlation (PARCOR)
coefficients in the statistics literature.
The signs of the coefficients used in this actor are appropriate for values
given by the LevinsonDurbin actor.
The structure of the filter is as follows:
y[0] y[1] y[n-1] y[n]
X(n) -------o-->-(+)-->----o-->-(+)-->-- ... ->---o-->-(+)------> Y(n)
| \ / \ / \ /
| +K1 / +K2 / +Kn /
| X X X
V -K1 \ -K2 \ -Kn \
| / \ / \ / \
\-[z]--o-->-(+)-[z]---o-->-(+)-[z]- ... ->---o-->-(+)
w[0] w[1] w[n-1] w[n]
References
[1]
J. Makhoul, "Linear Prediction: A Tutorial Review",
Proc. IEEE, Vol. 63, pp. 561-580, Apr. 1975.
[2]
S. M. Kay, Modern Spectral Estimation: Theory & Application,
Prentice-Hall, Englewood Cliffs, NJ, 1988.
- Since:
- Ptolemy II 1.0
- Version:
- $Id: Lattice.java,v 1.23 2004/04/13 03:03:15 cxh Exp $
- Author:
- Edward A. Lee, Christopher Hylands, Steve Neuendorffer
- See Also:
FIR,
LevinsonDurbin,
RecursiveLattice,
VariableLattice,
Serialized Form
- Accepted Rating:
- Proposed Rating:
| Nested classes inherited from class ptolemy.kernel.Entity |
ptolemy.kernel.Entity.ContainedObjectsIterator |
| Fields inherited from class ptolemy.actor.AtomicActor |
_stopRequested |
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Fields inherited from interface ptolemy.actor.Executable |
COMPLETED, NOT_READY, STOP_ITERATING |
|
Constructor Summary |
Lattice(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
Construct an actor with the given container and name. |
|
Method Summary |
protected void |
_doFilter()
|
protected void |
_reallocate()
|
void |
attributeChanged(ptolemy.kernel.util.Attribute attribute)
If the argument is the reflectionCoefficients parameter,
then reallocate the arrays to use. |
void |
fire()
Consume one input token, if there is one, and produce one output
token. |
void |
initialize()
Initialize the state of the filter. |
boolean |
postfire()
Update the backward and forward prediction errors that
were generated in fire() method. |
boolean |
prefire()
Check to see if this actor is ready to fire. |
| Methods inherited from class ptolemy.actor.TypedAtomicActor |
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup |
| Methods inherited from class ptolemy.kernel.ComponentEntity |
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName |
| Methods inherited from class ptolemy.kernel.Entity |
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables |
| Methods inherited from class ptolemy.kernel.InstantiableNamedObj |
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition |
| Methods inherited from class ptolemy.kernel.util.NamedObj |
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface ptolemy.actor.Actor |
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList |
| Methods inherited from interface ptolemy.actor.Executable |
iterate, preinitialize, stop, stopFire, terminate, wrapup |
| Methods inherited from interface ptolemy.kernel.util.Derivable |
getDerivedLevel, getDerivedList, propagateValue |
| Methods inherited from interface ptolemy.kernel.util.Nameable |
description, getFullName, getName, getName |
reflectionCoefficients
public ptolemy.data.expr.Parameter reflectionCoefficients
- The reflection coefficients. This is an array of doubles with
default value {0.804534, -0.820577, 0.521934, -0.205}. These
are the reflection coefficients for the linear predictor of a
particular random process.
_order
protected int _order
_backward
protected double[] _backward
_backwardCache
protected double[] _backwardCache
_forward
protected double[] _forward
_forwardCache
protected double[] _forwardCache
_reflectionCoefficients
protected double[] _reflectionCoefficients
Lattice
public Lattice(ptolemy.kernel.CompositeEntity container,
java.lang.String name)
throws ptolemy.kernel.util.NameDuplicationException,
ptolemy.kernel.util.IllegalActionException
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained
by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an
actor with this name.
attributeChanged
public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
throws ptolemy.kernel.util.IllegalActionException
- If the argument is the reflectionCoefficients parameter,
then reallocate the arrays to use.
- Parameters:
attribute - The attribute that changed.
- Throws:
ptolemy.kernel.util.IllegalActionException - If the base class throws it.
fire
public void fire()
throws ptolemy.kernel.util.IllegalActionException
- Consume one input token, if there is one, and produce one output
token. If there is no input, the produce no output.
- Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.
initialize
public void initialize()
throws ptolemy.kernel.util.IllegalActionException
- Initialize the state of the filter.
- Throws:
ptolemy.kernel.util.IllegalActionException
postfire
public boolean postfire()
throws ptolemy.kernel.util.IllegalActionException
- Update the backward and forward prediction errors that
were generated in fire() method.
- Returns:
- False if the number of iterations matches the number requested.
- Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.
prefire
public boolean prefire()
throws ptolemy.kernel.util.IllegalActionException
- Check to see if this actor is ready to fire.
- Throws:
ptolemy.kernel.util.IllegalActionException - If there is no director.
_doFilter
protected void _doFilter()
throws ptolemy.kernel.util.IllegalActionException
- Throws:
ptolemy.kernel.util.IllegalActionException
_reallocate
protected void _reallocate()