ptolemy.actor.lib
Class GradientAdaptiveLattice
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
ptolemy.actor.lib.GradientAdaptiveLattice
- All Implemented Interfaces:
- Actor, Changeable, java.lang.Cloneable, Debuggable, DebugListener, Derivable, Executable, Instantiable, ModelErrorHandler, MoMLExportable, Nameable, java.io.Serializable, TypedActor
- public class GradientAdaptiveLattice
- extends Lattice
An adaptive FIR filter with a lattice structure. This class extends
the base class to dynamically adapt the reflection coefficients to
minimize the power of the output sequence. The output reflection
coefficients are guaranteed to lie between -1.0 and 1.0, ensuring that the
resulting filter is a minimum phase linear predictor. The
reflectionCoefficients parameter is interpreted as the initial
coefficients.
- Since:
- Ptolemy II 4.0
- Version:
- $Id: GradientAdaptiveLattice.java,v 1.11 2004/04/13 03:03:09 cxh Exp $
- Author:
- Steve Neuendorffer
- See Also:
- Serialized Form
- Accepted Rating:
- Proposed Rating:
| Fields inherited from class ptolemy.kernel.util.NamedObj |
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS |
| Methods inherited from class ptolemy.actor.AtomicActor |
_createReceivers, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup |
| 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.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 |
adaptedReflectionCoefficients
public TypedIOPort adaptedReflectionCoefficients
- The output port that produces the current reflection
coefficients. The port is of type array of double.
timeConstant
public Parameter timeConstant
- The time constant of the filter, which determines how fast the
filter adapts.
The default value of this parameter is 1.0.
GradientAdaptiveLattice
public GradientAdaptiveLattice(CompositeEntity container,
java.lang.String name)
throws NameDuplicationException,
IllegalActionException
- Construct an actor with the given container and name.
- Parameters:
container - The container.name - The name of this actor.
- Throws:
IllegalActionException - If the actor cannot be contained
by the proposed container.
NameDuplicationException - If the container already has an
actor with this name.
attributeChanged
public void attributeChanged(Attribute attribute)
throws IllegalActionException
- Handle parameter change events on the
order and timeConstant parameters. The
filter state vector is reinitialized to zero state.
- Overrides:
attributeChanged in class Lattice
- Parameters:
attribute - The attribute that changed.
- Throws:
IllegalActionException - If this method is invoked
with an unrecognized parameter.
clone
public java.lang.Object clone(Workspace workspace)
throws java.lang.CloneNotSupportedException
- Clone the actor into the specified workspace. This calls the
base class and then sets the type constraints.
- Overrides:
clone in class AtomicActor
- Parameters:
workspace - The workspace for the new object.
- Returns:
- A new actor.
- Throws:
java.lang.CloneNotSupportedException - If a derived class has
an attribute that cannot be cloned.
initialize
public void initialize()
throws IllegalActionException
- Initialize the state of the filter.
- Specified by:
initialize in interface Executable- Overrides:
initialize in class Lattice
- Throws:
IllegalActionException
postfire
public boolean postfire()
throws IllegalActionException
- Update the filter state.
- Specified by:
postfire in interface Executable- Overrides:
postfire in class Lattice
- Returns:
- False if the number of iterations matches the number requested.
- Throws:
IllegalActionException - If the base class throws it.
_doFilter
protected void _doFilter()
throws IllegalActionException
- Overrides:
_doFilter in class Lattice
- Throws:
IllegalActionException
_reallocate
protected void _reallocate()
- Overrides:
_reallocate in class Lattice