ptolemy.actor.lib
Class GradientAdaptiveLattice

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.Transformer
                              extended byptolemy.actor.lib.Lattice
                                  extended byptolemy.actor.lib.GradientAdaptiveLattice
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

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:
Red (cxh)
Proposed Rating:
Red (vogel)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.actor.TypedIOPort adaptedReflectionCoefficients
          The output port that produces the current reflection coefficients.
 ptolemy.data.expr.Parameter timeConstant
          The time constant of the filter, which determines how fast the filter adapts.
 
Fields inherited from class ptolemy.actor.lib.Lattice
_backward, _backwardCache, _forward, _forwardCache, _order, _reflectionCoefficients, reflectionCoefficients
 
Fields inherited from class ptolemy.actor.lib.Transformer
input, output
 
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
GradientAdaptiveLattice(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)
          Handle parameter change events on the order and timeConstant parameters.
 java.lang.Object clone(ptolemy.kernel.util.Workspace workspace)
          Clone the actor into the specified workspace.
 void initialize()
          Initialize the state of the filter.
 boolean postfire()
          Update the filter state.
 
Methods inherited from class ptolemy.actor.lib.Lattice
fire, prefire
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
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.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
 

Field Detail

adaptedReflectionCoefficients

public ptolemy.actor.TypedIOPort adaptedReflectionCoefficients
The output port that produces the current reflection coefficients. The port is of type array of double.


timeConstant

public ptolemy.data.expr.Parameter timeConstant
The time constant of the filter, which determines how fast the filter adapts. The default value of this parameter is 1.0.

Constructor Detail

GradientAdaptiveLattice

public GradientAdaptiveLattice(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.
Method Detail

attributeChanged

public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
                      throws ptolemy.kernel.util.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:
ptolemy.kernel.util.IllegalActionException - If this method is invoked with an unrecognized parameter.

clone

public java.lang.Object clone(ptolemy.kernel.util.Workspace workspace)
                       throws java.lang.CloneNotSupportedException
Clone the actor into the specified workspace. This calls the base class and then sets the type constraints.

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 ptolemy.kernel.util.IllegalActionException
Initialize the state of the filter.

Specified by:
initialize in interface ptolemy.actor.Executable
Overrides:
initialize in class Lattice
Throws:
ptolemy.kernel.util.IllegalActionException

postfire

public boolean postfire()
                 throws ptolemy.kernel.util.IllegalActionException
Update the filter state.

Specified by:
postfire in interface ptolemy.actor.Executable
Overrides:
postfire in class Lattice
Returns:
False if the number of iterations matches the number requested.
Throws:
ptolemy.kernel.util.IllegalActionException - If the base class throws it.

_doFilter

protected void _doFilter()
                  throws ptolemy.kernel.util.IllegalActionException
Overrides:
_doFilter in class Lattice
Throws:
ptolemy.kernel.util.IllegalActionException

_reallocate

protected void _reallocate()
Overrides:
_reallocate in class Lattice