Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

ptolemy.backtrack.automatic.ptolemy.actor.lib
Class GradientAdaptiveLattice

java.lang.Object
  extended by ptolemy.kernel.util.NamedObj
      extended by ptolemy.kernel.InstantiableNamedObj
          extended by ptolemy.kernel.Entity
              extended by ptolemy.kernel.ComponentEntity
                  extended by ptolemy.actor.AtomicActor
                      extended by ptolemy.actor.TypedAtomicActor
                          extended by ptolemy.actor.lib.Transformer
                              extended by ptolemy.actor.lib.Lattice
                                  extended by ptolemy.backtrack.automatic.ptolemy.actor.lib.GradientAdaptiveLattice
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Actor, Executable, FiringsRecordable, Initializable, TypedActor, Rollbackable, Changeable, Debuggable, DebugListener, Derivable, Instantiable, ModelErrorHandler, MoMLExportable, Moveable, Nameable
public class GradientAdaptiveLattice
extends Lattice
implements Rollbackable

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 57040 2010-01-27 20:52:32Z cxh $
Author:
Steve Neuendorffer
See Also:
Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Red (vogel)

Nested Class Summary
 
Nested classes/interfaces inherited from class ptolemy.kernel.Entity
Entity.ContainedObjectsIterator
 
Field Summary
private  double _alpha
           
private  double[] _estimatedErrorPower
           
private  double[] _estimatedErrorPowerCache
           
private  double _oneMinusAlpha
           
private  double[] _reflectionCoefficientsCache
           
protected  Checkpoint $CHECKPOINT
           
private  FieldRecord $RECORD$_alpha
           
private  FieldRecord $RECORD$_estimatedErrorPower
           
private  FieldRecord $RECORD$_estimatedErrorPowerCache
           
private  FieldRecord $RECORD$_oneMinusAlpha
           
private  FieldRecord $RECORD$_reflectionCoefficientsCache
           
protected  CheckpointRecord $RECORD$$CHECKPOINT
           
private  FieldRecord[] $RECORDS
           
 TypedIOPort adaptedReflectionCoefficients
          The output port that produces the current reflection coefficients.
 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
_actorFiringListeners, _initializables, _notifyingActorFiring, _stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _verbose, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
GradientAdaptiveLattice(CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
protected  void _doFilter()
          Compute the filter, updating the caches, based on the current values.
protected  void _reallocate()
          Reallocate the internal arrays.
private  double $ASSIGN$_alpha(double newValue)
           
private  double[] $ASSIGN$_estimatedErrorPower(double[] newValue)
           
private  double $ASSIGN$_estimatedErrorPower(int index0, double newValue)
           
private  double[] $ASSIGN$_estimatedErrorPowerCache(double[] newValue)
           
private  double $ASSIGN$_estimatedErrorPowerCache(int index0, double newValue)
           
private  double $ASSIGN$_oneMinusAlpha(double newValue)
           
private  double[] $ASSIGN$_reflectionCoefficientsCache(double[] newValue)
           
private  double $ASSIGN$_reflectionCoefficientsCache(int index0, double newValue)
           
private  double[] $BACKUP$_estimatedErrorPower()
           
private  double[] $BACKUP$_estimatedErrorPowerCache()
           
private  double[] $BACKUP$_reflectionCoefficientsCache()
           
 void $COMMIT(long timestamp)
          Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.
 Checkpoint $GET$CHECKPOINT()
          Get the checkpoint object that monitors this rollbackable object.
 void $RESTORE(long timestamp, boolean trim)
          Restore a previous state to all the private fields of this rollbackable object.
 java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)
          Set the checkpoint object of this rollbackable object.
 void attributeChanged(Attribute attribute)
          Handle parameter change events on the order and timeConstant parameters.
 java.lang.Object clone(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, _fireAt, _fireAt, attributeTypeChanged, clone, newPort, typeConstraintList, typeConstraints
 
Methods inherited from class ptolemy.actor.AtomicActor
_actorFiring, _actorFiring, addActorFiringListener, addInitializable, connectionsChanged, createReceivers, declareDelayDependency, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, isFireFunctional, isStrict, iterate, newReceiver, outputPortList, preinitialize, pruneDependencies, recordFiring, removeActorFiringListener, removeDependency, removeInitializable, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, moveDown, moveToFirst, moveToIndex, moveToLast, moveUp, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, _validateSettables, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition, isWithinClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _adjustOverride, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _recordDecoratedAttributes, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, exportMoMLPlain, getAttribute, getAttributes, getChangeListeners, getClassName, getDecoratorAttribute, getDecoratorAttributes, getDerivedLevel, getDerivedList, getDisplayName, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, lazyContainedObjectsIterator, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setDisplayName, setModelErrorHandler, setPersistent, setSource, sortContainedObjects, toplevel, toString, validateSettables, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
createReceivers, getCausalityInterface, getDirector, getExecutiveDirector, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
isFireFunctional, isStrict, iterate, stop, stopFire, terminate
 
Methods inherited from interface ptolemy.actor.Initializable
addInitializable, preinitialize, removeInitializable, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getContainer, getDisplayName, getFullName, getName, getName, setName
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 

Field Detail

$CHECKPOINT

protected transient Checkpoint $CHECKPOINT

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.

_alpha

private double _alpha

_oneMinusAlpha

private double _oneMinusAlpha

_estimatedErrorPower

private double[] _estimatedErrorPower

_estimatedErrorPowerCache

private double[] _estimatedErrorPowerCache

_reflectionCoefficientsCache

private double[] _reflectionCoefficientsCache

$RECORD$$CHECKPOINT

protected transient CheckpointRecord $RECORD$$CHECKPOINT

$RECORD$_alpha

private transient FieldRecord $RECORD$_alpha

$RECORD$_oneMinusAlpha

private transient FieldRecord $RECORD$_oneMinusAlpha

$RECORD$_estimatedErrorPower

private transient FieldRecord $RECORD$_estimatedErrorPower

$RECORD$_estimatedErrorPowerCache

private transient FieldRecord $RECORD$_estimatedErrorPowerCache

$RECORD$_reflectionCoefficientsCache

private transient FieldRecord $RECORD$_reflectionCoefficientsCache

$RECORDS

private transient FieldRecord[] $RECORDS
Constructor Detail

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.
Method Detail

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 Lattice
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.
See Also:
NamedObj.exportMoML(Writer, int, String), NamedObj.setDeferringChangeRequests(boolean)

initialize

public void initialize()
                throws IllegalActionException
Initialize the state of the filter.

Specified by:
initialize in interface Initializable
Overrides:
initialize in class Lattice
Throws:
IllegalActionException - If a derived class throws it.

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
Description copied from class: Lattice
Compute the filter, updating the caches, based on the current values.

Overrides:
_doFilter in class Lattice
Throws:
IllegalActionException - Not thrown in this base class.

_reallocate

protected void _reallocate()
Description copied from class: Lattice
Reallocate the internal arrays.

Overrides:
_reallocate in class Lattice

$ASSIGN$_alpha

private final double $ASSIGN$_alpha(double newValue)

$ASSIGN$_oneMinusAlpha

private final double $ASSIGN$_oneMinusAlpha(double newValue)

$ASSIGN$_estimatedErrorPower

private final double[] $ASSIGN$_estimatedErrorPower(double[] newValue)

$ASSIGN$_estimatedErrorPower

private final double $ASSIGN$_estimatedErrorPower(int index0,
                                                  double newValue)

$BACKUP$_estimatedErrorPower

private final double[] $BACKUP$_estimatedErrorPower()

$ASSIGN$_estimatedErrorPowerCache

private final double[] $ASSIGN$_estimatedErrorPowerCache(double[] newValue)

$ASSIGN$_estimatedErrorPowerCache

private final double $ASSIGN$_estimatedErrorPowerCache(int index0,
                                                       double newValue)

$BACKUP$_estimatedErrorPowerCache

private final double[] $BACKUP$_estimatedErrorPowerCache()

$ASSIGN$_reflectionCoefficientsCache

private final double[] $ASSIGN$_reflectionCoefficientsCache(double[] newValue)

$ASSIGN$_reflectionCoefficientsCache

private final double $ASSIGN$_reflectionCoefficientsCache(int index0,
                                                          double newValue)

$BACKUP$_reflectionCoefficientsCache

private final double[] $BACKUP$_reflectionCoefficientsCache()

$COMMIT

public void $COMMIT(long timestamp)
Description copied from interface: Rollbackable
Commit changes up to the given timestamp, but not including changes made at timestamp and afterward.

Specified by:
$COMMIT in interface Rollbackable
Parameters:
timestamp - The timestamp.

$RESTORE

public void $RESTORE(long timestamp,
                     boolean trim)
Description copied from interface: Rollbackable
Restore a previous state to all the private fields of this rollbackable object.

Specified by:
$RESTORE in interface Rollbackable
Parameters:
timestamp - The timestamp taken at the time when the previous state was recorded.
trim - Whether to delete the records used for the rollback.
See Also:
Checkpoint.rollback(long, boolean)

$GET$CHECKPOINT

public final Checkpoint $GET$CHECKPOINT()
Description copied from interface: Rollbackable
Get the checkpoint object that monitors this rollbackable object.

Specified by:
$GET$CHECKPOINT in interface Rollbackable
Returns:
The checkpoint object.

$SET$CHECKPOINT

public final java.lang.Object $SET$CHECKPOINT(Checkpoint checkpoint)
Description copied from interface: Rollbackable
Set the checkpoint object of this rollbackable object. A merge operation is performed on the current checkpoint object and the new checkpoint object, so that the two checkpoint objects monitor the same set of objects when this function returns.

Specified by:
$SET$CHECKPOINT in interface Rollbackable
Parameters:
checkpoint - The new checkpoint object.
Returns:
This rollbackable object itself.
See Also:
Checkpoint.setCheckpoint(Checkpoint)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD